<appendix id="GarminIcons">
-<title>Garmin Icons</title>
-<para>
-Following is a list of the valid values for the
-<link linkend="fmt_garmin">garmin</link> <option>deficon</option> option.
-These values are also used internally by the
-<link linkend="fmt_gdb">GDB</link>,
-<link linkend="fmt_bcr">BCR</link>,
-<link linkend="fmt_mapsource">Mapsource</link>,
-<link linkend="fmt_pcx">PCX</link>, and
-<link linkend="fmt_psitrex">PSITrex</link>
-formats.
-</para>
+ <title>Garmin Icons</title>
+ <para>Following is a list of the valid values for the
-<simplelist columns="5">
-<member>ATV</member>
-<member>Airport</member>
-<member>Amusement Park</member>
-<member>Anchor</member>
-<member>Anchor Prohibited</member>
-<member>Animal Tracks</member>
-<member>Asian Food</member>
-<member>Bait and Tackle</member>
-<member>Ball Park</member>
-<member>Bank</member>
-<member>Bar</member>
-<member>Beach</member>
-<member>Beacon</member>
-<member>Bell</member>
-<member>Big Game</member>
-<member>Bike Trail</member>
-<member>Blind</member>
-<member>Block, Blue</member>
-<member>Block, Green</member>
-<member>Block, Red</member>
-<member>Blood Trail</member>
-<member>Boat Ramp</member>
-<member>Border Crossing (Port Of Entry)</member>
-<member>Bottom Conditions</member>
-<member>Bowling</member>
-<member>Bridge</member>
-<member>Building</member>
-<member>Buoy, White</member>
-<member>Campground</member>
-<member>Car</member>
-<member>Car Rental</member>
-<member>Car Repair</member>
-<member>Cemetery</member>
-<member>Church</member>
-<member>Circle with X</member>
-<member>Circle, Blue</member>
-<member>Circle, Green</member>
-<member>Circle, Red</member>
-<member>City (Capitol)</member>
-<member>City (Large)</member>
-<member>City (Medium)</member>
-<member>City (Small)</member>
-<member>City Hall</member>
-<member>Civil</member>
-<member>Coast Guard</member>
-<member>Contact, Afro</member>
-<member>Contact, Alien</member>
-<member>Contact, Ball Cap</member>
-<member>Contact, Big Ears</member>
-<member>Contact, Biker</member>
-<member>Contact, Blonde</member>
-<member>Contact, Bug</member>
-<member>Contact, Cat</member>
-<member>Contact, Clown</member>
-<member>Contact, Dog</member>
-<member>Contact, Dreadlocks</member>
-<member>Contact, Female1</member>
-<member>Contact, Female2</member>
-<member>Contact, Female3</member>
-<member>Contact, Glasses</member>
-<member>Contact, Goatee</member>
-<member>Contact, Kung-Fu</member>
-<member>Contact, Panda</member>
-<member>Contact, Pig</member>
-<member>Contact, Pirate</member>
-<member>Contact, Ranger</member>
-<member>Contact, Smiley</member>
-<member>Contact, Spike</member>
-<member>Contact, Sumo</member>
-<member>Controlled Area</member>
-<member>Convenience Store</member>
-<member>Cover</member>
-<member>Covey</member>
-<member>Crossing</member>
-<member>Dam</member>
-<member>Danger Area</member>
-<member>Deli</member>
-<member>Department Store</member>
-<member>Diamond, Blue</member>
-<member>Diamond, Green</member>
-<member>Diamond, Red</member>
-<member>Diver Down Flag 1</member>
-<member>Diver Down Flag 2</member>
-<member>Dock</member>
-<member>Dot, White</member>
-<member>Drinking Water</member>
-<member>Dropoff</member>
-<member>Elevation point</member>
-<member>Event Cache</member>
-<member>Exit</member>
-<member>Exit without services</member>
-<member>Fast Food</member>
-<member>First approach fix</member>
-<member>Fishing Area</member>
-<member>Fishing Hot Spot Facility</member>
-<member>Fitness Center</member>
-<member>Flag</member>
-<member>Flag, Blue</member>
-<member>Flag, Green</member>
-<member>Flag, Red</member>
-<member>Food Source</member>
-<member>Forest</member>
-<member>Furbearer</member>
-<member>Gambling/casino</member>
-<member>Gas Station</member>
-<member>Geocache</member>
-<member>Geocache Found</member>
-<member>Geographic place name, Man-made</member>
-<member>Geographic place name, land</member>
-<member>Geographic place name, water</member>
-<member>Ghost Town</member>
-<member>Glider Area</member>
-<member>Golf Course</member>
-<member>Ground Transportation</member>
-<member>Heliport</member>
-<member>Horn</member>
-<member>Hotel</member>
-<member>House</member>
-<member>Hunting Area</member>
-<member>Ice Skating</member>
-<member>Information</member>
-<member>Intersection</member>
-<member>Intl freeway hwy</member>
-<member>Intl national hwy</member>
-<member>Italian food</member>
-<member>Large Ramp intersection</member>
-<member>Large exit without services</member>
-<member>Letter A, Blue</member>
-<member>Letter A, Green</member>
-<member>Letter A, Red</member>
-<member>Letter B, Blue</member>
-<member>Letter B, Green</member>
-<member>Letter B, Red</member>
-<member>Letter C, Blue</member>
-<member>Letter C, Green</member>
-<member>Letter C, Red</member>
-<member>Letter D, Blue</member>
-<member>Letter D, Green</member>
-<member>Letter D, Red</member>
-<member>Letterbox Cache</member>
-<member>Levee</member>
-<member>Library</member>
-<member>Light</member>
-<member>Live Theater</member>
-<member>Localizer Outer Marker</member>
-<member>Locationless (Reverse) Cache</member>
-<member>Lodge</member>
-<member>Lodging</member>
-<member>Man Overboard</member>
-<member>Marina</member>
-<member>Medical Facility</member>
-<member>Micro-Cache</member>
-<member>Mile Marker</member>
-<member>Military</member>
-<member>Mine</member>
-<member>Missed approach point</member>
-<member>Movie Theater</member>
-<member>Multi-Cache</member>
-<member>Multi-Cache</member>
-<member>Museum</member>
-<member>Navaid, Amber</member>
-<member>Navaid, Black</member>
-<member>Navaid, Blue</member>
-<member>Navaid, Green</member>
-<member>Navaid, Green/Red</member>
-<member>Navaid, Green/White</member>
-<member>Navaid, Orange</member>
-<member>Navaid, Red</member>
-<member>Navaid, Red/Green</member>
-<member>Navaid, Red/White</member>
-<member>Navaid, Violet</member>
-<member>Navaid, White</member>
-<member>Navaid, White/Green</member>
-<member>Navaid, White/Red</member>
-<member>Non-directional beacon</member>
-<member>Null</member>
-<member>Number 0, Blue</member>
-<member>Number 0, Green</member>
-<member>Number 0, Red</member>
-<member>Number 1, Blue</member>
-<member>Number 1, Green</member>
-<member>Number 1, Red</member>
-<member>Number 2, Blue</member>
-<member>Number 2, Green</member>
-<member>Number 2, Red</member>
-<member>Number 3, Blue</member>
-<member>Number 3, Green</member>
-<member>Number 3, Red</member>
-<member>Number 4, Blue</member>
-<member>Number 4, Green</member>
-<member>Number 4, Red</member>
-<member>Number 5, Blue</member>
-<member>Number 5, Green</member>
-<member>Number 5, Red</member>
-<member>Number 6, Blue</member>
-<member>Number 6, Green</member>
-<member>Number 6, Red</member>
-<member>Number 7, Blue</member>
-<member>Number 7, Green</member>
-<member>Number 7, Red</member>
-<member>Number 8, Blue</member>
-<member>Number 8, Green</member>
-<member>Number 8, Red</member>
-<member>Number 9, Blue</member>
-<member>Number 9, Green</member>
-<member>Number 9, Red</member>
-<member>Oil Field</member>
-<member>Open 24 Hours</member>
-<member>Oval, Blue</member>
-<member>Oval, Green</member>
-<member>Oval, Red</member>
-<member>Parachute Area</member>
-<member>Park</member>
-<member>Parking Area</member>
-<member>Pharmacy</member>
-<member>Picnic Area</member>
-<member>Pin, Blue</member>
-<member>Pin, Green</member>
-<member>Pin, Red</member>
-<member>Pizza</member>
-<member>Police Station</member>
-<member>Post Office</member>
-<member>Post Office</member>
-<member>Private Field</member>
-<member>Puzzle Cache</member>
-<member>RV Park</member>
-<member>Radio Beacon</member>
-<member>Ramp intersection</member>
-<member>Rectangle, Blue</member>
-<member>Rectangle, Green</member>
-<member>Rectangle, Red</member>
-<member>Reef</member>
-<member>Residence</member>
-<member>Restaurant</member>
-<member>Restricted Area</member>
-<member>Restroom</member>
-<member>Scales</member>
-<member>Scenic Area</member>
-<member>School</member>
-<member>Seafood</member>
-<member>Seaplane Base</member>
-<member>Shipwreck</member>
-<member>Shopping Center</member>
-<member>Short Tower</member>
-<member>Shower</member>
-<member>Ski Resort</member>
-<member>Skiing Area</member>
-<member>Skull and Crossbones</member>
-<member>Small City</member>
-<member>Small Game</member>
-<member>Soft Field</member>
-<member>Square, Blue</member>
-<member>Square, Green</member>
-<member>Square, Red</member>
-<member>Stadium</member>
-<member>State Hwy</member>
-<member>Steak</member>
-<member>Street Intersection</member>
-<member>Stump</member>
-<member>Summit</member>
-<member>Swimming Area</member>
-<member>TACAN</member>
-<member>Tall Tower</member>
-<member>Telephone</member>
-<member>Tide/Current PRediction Station</member>
-<member>Toll Booth</member>
-<member>TracBack Point</member>
-<member>Trail Head</member>
-<member>Tree Stand</member>
-<member>Treed Quarry</member>
-<member>Triangle, Blue</member>
-<member>Triangle, Green</member>
-<member>Triangle, Red</member>
-<member>Truck</member>
-<member>Truck Stop</member>
-<member>Tunnel</member>
-<member>U Marina</member>
-<member>U stump</member>
-<member>US hwy</member>
-<member>Ultralight Area</member>
-<member>Unknown Cache</member>
-<member>Upland Game</member>
-<member>VHF Omni-range</member>
-<member>VOR-DME</member>
-<member>VOR/TACAN</member>
-<member>Virtual cache</member>
-<member>Water Hydrant</member>
-<member>Water Source</member>
-<member>Waterfowl</member>
-<member>Waypoint</member>
-<member>Webcam Cache</member>
-<member>Weed Bed</member>
-<member>Winery</member>
-<member>Wrecker</member>
-<member>Zoo</member>
-</simplelist>
-</appendix>
+ <link linkend="fmt_garmin">garmin</link>
+ <option>deficon</option>
+ option.
+These values are also used internally by the
+
+ <link linkend="fmt_gdb">GDB</link>
+ ,
+
+ <link linkend="fmt_bcr">BCR</link>
+ ,
+
+ <link linkend="fmt_mapsource">Mapsource</link>
+ ,
+
+ <link linkend="fmt_pcx">PCX</link>
+ , and
+
+ <link linkend="fmt_psitrex">PSITrex</link>
+ formats.</para>
+ <simplelist columns="5">
+ <member>ATV</member>
+ <member>Airport</member>
+ <member>Amusement Park</member>
+ <member>Anchor</member>
+ <member>Anchor Prohibited</member>
+ <member>Animal Tracks</member>
+ <member>Asian Food</member>
+ <member>Bait and Tackle</member>
+ <member>Ball Park</member>
+ <member>Bank</member>
+ <member>Bar</member>
+ <member>Beach</member>
+ <member>Beacon</member>
+ <member>Bell</member>
+ <member>Big Game</member>
+ <member>Bike Trail</member>
+ <member>Blind</member>
+ <member>Block, Blue</member>
+ <member>Block, Green</member>
+ <member>Block, Red</member>
+ <member>Blood Trail</member>
+ <member>Boat Ramp</member>
+ <member>Border Crossing (Port Of Entry)</member>
+ <member>Bottom Conditions</member>
+ <member>Bowling</member>
+ <member>Bridge</member>
+ <member>Building</member>
+ <member>Buoy, White</member>
+ <member>Campground</member>
+ <member>Car</member>
+ <member>Car Rental</member>
+ <member>Car Repair</member>
+ <member>Cemetery</member>
+ <member>Church</member>
+ <member>Circle with X</member>
+ <member>Circle, Blue</member>
+ <member>Circle, Green</member>
+ <member>Circle, Red</member>
+ <member>City (Capitol)</member>
+ <member>City (Large)</member>
+ <member>City (Medium)</member>
+ <member>City (Small)</member>
+ <member>City Hall</member>
+ <member>Civil</member>
+ <member>Coast Guard</member>
+ <member>Contact, Afro</member>
+ <member>Contact, Alien</member>
+ <member>Contact, Ball Cap</member>
+ <member>Contact, Big Ears</member>
+ <member>Contact, Biker</member>
+ <member>Contact, Blonde</member>
+ <member>Contact, Bug</member>
+ <member>Contact, Cat</member>
+ <member>Contact, Clown</member>
+ <member>Contact, Dog</member>
+ <member>Contact, Dreadlocks</member>
+ <member>Contact, Female1</member>
+ <member>Contact, Female2</member>
+ <member>Contact, Female3</member>
+ <member>Contact, Glasses</member>
+ <member>Contact, Goatee</member>
+ <member>Contact, Kung-Fu</member>
+ <member>Contact, Panda</member>
+ <member>Contact, Pig</member>
+ <member>Contact, Pirate</member>
+ <member>Contact, Ranger</member>
+ <member>Contact, Smiley</member>
+ <member>Contact, Spike</member>
+ <member>Contact, Sumo</member>
+ <member>Controlled Area</member>
+ <member>Convenience Store</member>
+ <member>Cover</member>
+ <member>Covey</member>
+ <member>Crossing</member>
+ <member>Dam</member>
+ <member>Danger Area</member>
+ <member>Deli</member>
+ <member>Department Store</member>
+ <member>Diamond, Blue</member>
+ <member>Diamond, Green</member>
+ <member>Diamond, Red</member>
+ <member>Diver Down Flag 1</member>
+ <member>Diver Down Flag 2</member>
+ <member>Dock</member>
+ <member>Dot, White</member>
+ <member>Drinking Water</member>
+ <member>Dropoff</member>
+ <member>Elevation point</member>
+ <member>Event Cache</member>
+ <member>Exit</member>
+ <member>Exit without services</member>
+ <member>Fast Food</member>
+ <member>First approach fix</member>
+ <member>Fishing Area</member>
+ <member>Fishing Hot Spot Facility</member>
+ <member>Fitness Center</member>
+ <member>Flag</member>
+ <member>Flag, Blue</member>
+ <member>Flag, Green</member>
+ <member>Flag, Red</member>
+ <member>Food Source</member>
+ <member>Forest</member>
+ <member>Furbearer</member>
+ <member>Gambling/casino</member>
+ <member>Gas Station</member>
+ <member>Geocache</member>
+ <member>Geocache Found</member>
+ <member>Geographic place name, Man-made</member>
+ <member>Geographic place name, land</member>
+ <member>Geographic place name, water</member>
+ <member>Ghost Town</member>
+ <member>Glider Area</member>
+ <member>Golf Course</member>
+ <member>Ground Transportation</member>
+ <member>Heliport</member>
+ <member>Horn</member>
+ <member>Hotel</member>
+ <member>House</member>
+ <member>Hunting Area</member>
+ <member>Ice Skating</member>
+ <member>Information</member>
+ <member>Intersection</member>
+ <member>Intl freeway hwy</member>
+ <member>Intl national hwy</member>
+ <member>Italian food</member>
+ <member>Large Ramp intersection</member>
+ <member>Large exit without services</member>
+ <member>Letter A, Blue</member>
+ <member>Letter A, Green</member>
+ <member>Letter A, Red</member>
+ <member>Letter B, Blue</member>
+ <member>Letter B, Green</member>
+ <member>Letter B, Red</member>
+ <member>Letter C, Blue</member>
+ <member>Letter C, Green</member>
+ <member>Letter C, Red</member>
+ <member>Letter D, Blue</member>
+ <member>Letter D, Green</member>
+ <member>Letter D, Red</member>
+ <member>Letterbox Cache</member>
+ <member>Levee</member>
+ <member>Library</member>
+ <member>Light</member>
+ <member>Live Theater</member>
+ <member>Localizer Outer Marker</member>
+ <member>Locationless (Reverse) Cache</member>
+ <member>Lodge</member>
+ <member>Lodging</member>
+ <member>Man Overboard</member>
+ <member>Marina</member>
+ <member>Medical Facility</member>
+ <member>Micro-Cache</member>
+ <member>Mile Marker</member>
+ <member>Military</member>
+ <member>Mine</member>
+ <member>Missed approach point</member>
+ <member>Movie Theater</member>
+ <member>Multi-Cache</member>
+ <member>Multi-Cache</member>
+ <member>Museum</member>
+ <member>Navaid, Amber</member>
+ <member>Navaid, Black</member>
+ <member>Navaid, Blue</member>
+ <member>Navaid, Green</member>
+ <member>Navaid, Green/Red</member>
+ <member>Navaid, Green/White</member>
+ <member>Navaid, Orange</member>
+ <member>Navaid, Red</member>
+ <member>Navaid, Red/Green</member>
+ <member>Navaid, Red/White</member>
+ <member>Navaid, Violet</member>
+ <member>Navaid, White</member>
+ <member>Navaid, White/Green</member>
+ <member>Navaid, White/Red</member>
+ <member>Non-directional beacon</member>
+ <member>Null</member>
+ <member>Number 0, Blue</member>
+ <member>Number 0, Green</member>
+ <member>Number 0, Red</member>
+ <member>Number 1, Blue</member>
+ <member>Number 1, Green</member>
+ <member>Number 1, Red</member>
+ <member>Number 2, Blue</member>
+ <member>Number 2, Green</member>
+ <member>Number 2, Red</member>
+ <member>Number 3, Blue</member>
+ <member>Number 3, Green</member>
+ <member>Number 3, Red</member>
+ <member>Number 4, Blue</member>
+ <member>Number 4, Green</member>
+ <member>Number 4, Red</member>
+ <member>Number 5, Blue</member>
+ <member>Number 5, Green</member>
+ <member>Number 5, Red</member>
+ <member>Number 6, Blue</member>
+ <member>Number 6, Green</member>
+ <member>Number 6, Red</member>
+ <member>Number 7, Blue</member>
+ <member>Number 7, Green</member>
+ <member>Number 7, Red</member>
+ <member>Number 8, Blue</member>
+ <member>Number 8, Green</member>
+ <member>Number 8, Red</member>
+ <member>Number 9, Blue</member>
+ <member>Number 9, Green</member>
+ <member>Number 9, Red</member>
+ <member>Oil Field</member>
+ <member>Open 24 Hours</member>
+ <member>Oval, Blue</member>
+ <member>Oval, Green</member>
+ <member>Oval, Red</member>
+ <member>Parachute Area</member>
+ <member>Park</member>
+ <member>Parking Area</member>
+ <member>Pharmacy</member>
+ <member>Picnic Area</member>
+ <member>Pin, Blue</member>
+ <member>Pin, Green</member>
+ <member>Pin, Red</member>
+ <member>Pizza</member>
+ <member>Police Station</member>
+ <member>Post Office</member>
+ <member>Post Office</member>
+ <member>Private Field</member>
+ <member>Puzzle Cache</member>
+ <member>RV Park</member>
+ <member>Radio Beacon</member>
+ <member>Ramp intersection</member>
+ <member>Rectangle, Blue</member>
+ <member>Rectangle, Green</member>
+ <member>Rectangle, Red</member>
+ <member>Reef</member>
+ <member>Residence</member>
+ <member>Restaurant</member>
+ <member>Restricted Area</member>
+ <member>Restroom</member>
+ <member>Scales</member>
+ <member>Scenic Area</member>
+ <member>School</member>
+ <member>Seafood</member>
+ <member>Seaplane Base</member>
+ <member>Shipwreck</member>
+ <member>Shopping Center</member>
+ <member>Short Tower</member>
+ <member>Shower</member>
+ <member>Ski Resort</member>
+ <member>Skiing Area</member>
+ <member>Skull and Crossbones</member>
+ <member>Small City</member>
+ <member>Small Game</member>
+ <member>Soft Field</member>
+ <member>Square, Blue</member>
+ <member>Square, Green</member>
+ <member>Square, Red</member>
+ <member>Stadium</member>
+ <member>State Hwy</member>
+ <member>Steak</member>
+ <member>Street Intersection</member>
+ <member>Stump</member>
+ <member>Summit</member>
+ <member>Swimming Area</member>
+ <member>TACAN</member>
+ <member>Tall Tower</member>
+ <member>Telephone</member>
+ <member>Tide/Current PRediction Station</member>
+ <member>Toll Booth</member>
+ <member>TracBack Point</member>
+ <member>Trail Head</member>
+ <member>Tree Stand</member>
+ <member>Treed Quarry</member>
+ <member>Triangle, Blue</member>
+ <member>Triangle, Green</member>
+ <member>Triangle, Red</member>
+ <member>Truck</member>
+ <member>Truck Stop</member>
+ <member>Tunnel</member>
+ <member>U Marina</member>
+ <member>U stump</member>
+ <member>US hwy</member>
+ <member>Ultralight Area</member>
+ <member>Unknown Cache</member>
+ <member>Upland Game</member>
+ <member>VHF Omni-range</member>
+ <member>VOR-DME</member>
+ <member>VOR/TACAN</member>
+ <member>Virtual cache</member>
+ <member>Water Hydrant</member>
+ <member>Water Source</member>
+ <member>Waterfowl</member>
+ <member>Waypoint</member>
+ <member>Webcam Cache</member>
+ <member>Weed Bed</member>
+ <member>Winery</member>
+ <member>Wrecker</member>
+ <member>Zoo</member>
+ </simplelist>
+</appendix>
\ No newline at end of file
<appendix id="Styles">
-<title>GPSBabel XCSV Style Files</title>
-
-<section id="styles_intro">
-<title>Introduction to GPSBabel Styles</title>
-<para>
-Often it is desirable to add a new file format for "one-off" work (perhaps
+ <title>GPSBabel XCSV Style Files</title>
+ <section id="styles_intro">
+ <title>Introduction to GPSBabel Styles</title>
+ <para>Often it is desirable to add a new file format for "one-off" work (perhaps
you want to export something to a spreadsheet or graphing program) or to read
a format that GPSBabel does not yet support. For suitably simple formats,
-this can be done by a user with no programming experience by providing a
+this can be done by a user with no programming experience by providing a
GPSBabel style file.
</para>
-<para>
-For a format to be described by a style file, it must be predictable and
-generally readable by humant. Formats with binary or unreadable content
+ <para>For a format to be described by a style file, it must be predictable and
+generally readable by humant. Formats with binary or unreadable content
are not good fits for this scheme. It should have:
-<simplelist>
-<member>A fixed header at the beginning, if it has any at all. This is called a 'prologue'.</member>
-<member>Waypoints that are grouped by fixed separators, often a newline. In style file parlance, this is called a 'record'.</member>
-<member>Traits of that waypoint described in that record. In the style files, these are called 'fields' and examples may include longitude or a name.</member>
-<member>Fields that are grouped by fixed separators, often a comma or a tab. In the style files, this is called the field separator. Fields may be enclosed by characters, such as a double quote.</member>
-<member>A fixed footer at the end, if it has any at all. This is called the 'epilogue'.</member>
-</simplelist>
-</para>
-<para>
-Once you have created a style file that describes the file format you have
-or want, you must tell GPSBabel to use the xcsv format and have the xcsv
-format use that file. If you created a new style file called
-"mystyle.style" and you want to write the waypoints from
-a GPX file named "mine.gpx" to it, you would issue a command like:
-</para>
-<para><userinput>gpsbabel -i gpx -f mine.gpx -o xcsv,style=mystyle.style -F mine.new</userinput></para>
-<para>
-You might then examine <filename>mine.new</filename> to see if it met
-your expectations. If not, you could continue to tweak
-<filename>mystyle.style</filename> until it did, rerunning the above
-command each time. If 'mystyle' is a format
+ <simplelist>
+ <member>A fixed header at the beginning, if it has any at all. This is called a 'prologue'.</member>
+ <member>Waypoints that are grouped by fixed separators, often a newline. In style file parlance, this is called a 'record'.</member>
+ <member>Traits of that waypoint described in that record. In the style files, these are called 'fields' and examples may include longitude or a name.</member>
+ <member>Fields that are grouped by fixed separators, often a comma or a tab. In the style files, this is called the field separator. Fields may be enclosed by characters, such as a double quote.</member>
+ <member>A fixed footer at the end, if it has any at all. This is called the 'epilogue'.</member></simplelist>
+ </para>
+ <para>Once you have created a style file that describes the file format you have
+or want, you must tell GPSBabel to use the xcsv format and have the xcsv
+format use that file. If you created a new style file called
+"mystyle.style" and you want to write the waypoints from
+a GPX file named "mine.gpx" to it, you would issue a command like:
+</para>
+ <para>
+ <userinput>gpsbabel -i gpx -f mine.gpx -o xcsv,style=mystyle.style -F mine.new</userinput>
+ </para>
+ <para>You might then examine
+ <filename>mine.new</filename>
+ to see if it met
+your expectations. If not, you could continue to tweak
+
+ <filename>mystyle.style</filename>
+ until it did, rerunning the above
+command each time. If 'mystyle' is a format
that describes a popular program or is likely to be of use to others, you can
-then share <filename>mystyle.style</filename> with other GPSBabel users.
-Send it along with a coherent description to the GPSBabel-Misc mailing
-list for consideration to be included in a future version.
-</para>
-</section>
-<section id="style_intro2">
-<title>Style file overview</title>
-<para>
-The first and foremost important step is understanding how the style
+then share
+
+
+
+
+
+
+ <filename>mystyle.style</filename>
+ with other GPSBabel users.
+Send it along with a coherent description to the GPSBabel-Misc mailing
+list for consideration to be included in a future version.</para>
+ </section>
+ <section id="style_intro2">
+ <title>Style file overview</title>
+ <para>The first and foremost important step is understanding how the style
file is laid out itself. The format is:
</para>
-<screen format="linespecific">DIRECTIVE<whitespace>VALUE</screen>
-<para>
-Where <whitespace> is one or more spaces or tabs. There should
+ <screen format="linespecific">DIRECTIVE<whitespace>VALUE</screen>
+ <para>Where <whitespace> is one or more spaces or tabs. There should
be no spaces or tabs at the beginning of the line; all directives start
at the left edge in column zero.
</para>
-<para>
-An example style format is shown here:
-<literallayout>
+ <para>An example style format is shown here:
+
+
+
+
+
+
-# Format: MS S&T 2002/2003
+ <literallayout># Format: MS S&T 2002/2003
# Author: Alex Mottram
# Date: 12/09/2002
#
-DESCRIPTION Microsoft Streets and Trips 2002-2006
+DESCRIPTION Microsoft Streets and Trips 2002-2006
EXTENSION txt
#
# FILE LAYOUT DEFINITIIONS:
#
-FIELD_DELIMITER TAB
-RECORD_DELIMITER NEWLINE
-BADCHARS ,"
+FIELD_DELIMITER TAB
+RECORD_DELIMITER NEWLINE
+BADCHARS ,"
-PROLOGUE Name Latitude Longitude Description URL Type Container Diff Terr
+PROLOGUE Name Latitude Longitude Description URL Type Container Diff Terr
#
# INDIVIDUAL DATA FIELDS, IN ORDER OF APPEARANCE:
-# NOTE: MS S&T ONLY IMPORTS DATA, IT DOESN'T
-# EXPORT THIS ANYWHERE SO WE CAN HAVE OUR
-# WAY WITH THE FORMATTING.
+# NOTE: MS S&T ONLY IMPORTS DATA, IT DOESN'T
+# EXPORT THIS ANYWHERE SO WE CAN HAVE OUR
+# WAY WITH THE FORMATTING.
#
-IFIELD SHORTNAME, "", "%s" # Name
-IFIELD LAT_DECIMAL, "", "%f" # Latitude
-IFIELD LON_DECIMAL, "", "%f" # Longitude
-IFIELD DESCRIPTION, "", "%s" # Name 2 (Big Description)
-IFIELD URL, "", "%s" # URL
-IFIELD GEOCACHE_TYPE, "", "%s" # Geocache Type
-IFIELD GEOCACHE_CONTAINER, "", "%s" # Geocache Type
-IFIELD GEOCACHE_DIFF, "", "%3.1f" # Geocache Type
-IFIELD GEOCACHE_TERR, "", "%3.1f" # Geocache Type
+IFIELD SHORTNAME, "", "%s" # Name
+IFIELD LAT_DECIMAL, "", "%f" # Latitude
+IFIELD LON_DECIMAL, "", "%f" # Longitude
+IFIELD DESCRIPTION, "", "%s" # Name 2 (Big Description)
+IFIELD URL, "", "%s" # URL
+IFIELD GEOCACHE_TYPE, "", "%s" # Geocache Type
+IFIELD GEOCACHE_CONTAINER, "", "%s" # Geocache Type
+IFIELD GEOCACHE_DIFF, "", "%3.1f" # Geocache Type
+IFIELD GEOCACHE_TERR, "", "%3.1f" # Geocache Type
</literallayout>
-Each of these lines will be explained in the following sections.
-</para>
-</section> <!-- intro -->
-
-<section id="styles_internal_const">
-<title>Internal Constants</title>
-<para>
-A few internal constants are defined in the XCSV parser to make the style
-file simpler. They may or may not be used and are optional in most cases.
+ Each of these lines will be explained in the following sections.</para>
+ </section>
+ <!-- intro -->
+ <section id="styles_internal_const">
+ <title>Internal Constants</title>
+ <para>A few internal constants are defined in the XCSV parser to make the style
+file simpler. They may or may not be used and are optional in most cases.
Note that only certain style file directives map these constants.
</para>
-<para>
-<segmentedlist>
-<?dbhtml list-presentation="table"?>
-<segtitle>Style Constant</segtitle>
-<segtitle>Maps to Char(s)</segtitle>
-<seglistitem>
-<seg>COMMA</seg><seg>,</seg>
-</seglistitem>
-<seglistitem>
-<seg>COMMASPACE</seg><seg>,<space></seg>
-</seglistitem>
-<seglistitem>
-<seg>SINGLEQUOTE</seg><seg>'</seg>
-</seglistitem>
-<seglistitem>
-<seg>DOUBLEQUOTE</seg><seg>"</seg>
-</seglistitem>
-<seglistitem>
-<seg>COLON</seg><seg>:</seg>
-</seglistitem>
-<seglistitem>
-<seg>SEMICOLON</seg><seg>;</seg>
-</seglistitem>
-<seglistitem>
-<seg>NEWLINE</seg><seg>\n</seg>
-</seglistitem>
-<seglistitem>
-<seg>CR</seg><seg>\r</seg>
-</seglistitem>
-<seglistitem>
-<seg>CRNEWLINE</seg><seg>\r\n</seg>
-</seglistitem>
-<seglistitem>
-<seg>TAB</seg><seg>\t</seg>
-</seglistitem>
-<seglistitem>
-<seg>SPACE</seg><seg><space></seg>
-</seglistitem>
-<seglistitem>
-<seg>HASH</seg><seg>#</seg>
-</seglistitem>
-<seglistitem>
-<seg>PIPE</seg><seg>|</seg>
-</seglistitem>
-<seglistitem>
-<seg>WHITESPACE</seg><seg>see below</seg>
-</seglistitem>
-</segmentedlist>
-</para>
-<section id="style_const_whitespace">
-<title>WHITESPACE</title>
-<para>
-The WHITESPACE constant has special properties. When reading data,
+ <para>
+ <segmentedlist>
+ <?dbhtml list-presentation="table"?>
+ <segtitle>Style Constant</segtitle>
+ <segtitle>Maps to Char(s)</segtitle>
+ <seglistitem>
+ <seg>COMMA</seg>
+ <seg>,</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>COMMASPACE</seg>
+ <seg>,<space></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>SINGLEQUOTE</seg>
+ <seg>'</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>DOUBLEQUOTE</seg>
+ <seg>"</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>COLON</seg>
+ <seg>:</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>SEMICOLON</seg>
+ <seg>;</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>NEWLINE</seg>
+ <seg>\n</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>CR</seg>
+ <seg>\r</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>CRNEWLINE</seg>
+ <seg>\r\n</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>TAB</seg>
+ <seg>\t</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>SPACE</seg>
+ <seg><space></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>HASH</seg>
+ <seg>#</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>PIPE</seg>
+ <seg>|</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>WHITESPACE</seg>
+ <seg>see below</seg>
+ </seglistitem>
+ </segmentedlist>
+ </para>
+ <section id="style_const_whitespace">
+ <title>WHITESPACE</title>
+ <para>The WHITESPACE constant has special properties. When reading data,
WHITESPACE refers to sequential runs of SPACES and/or TABS. When
writing data, WHITESPACE is always a single SPACE.
</para>
-<para>
-For example, the following line:
+ <para>For example, the following line:
</para>
-<screen format="linespecific">SOME_NAME 30.1208 -91.1365 SOME OTHER NAME
+ <screen format="linespecific">SOME_NAME 30.1208 -91.1365 SOME OTHER NAME
</screen>
-<para>
-Parses into the following data fields:
+ <para>Parses into the following data fields:
</para>
-<screen format="linespecific">SOME_NAME,30.1208,-91.1365,SOME,OTHER,NAME
+ <screen format="linespecific">SOME_NAME,30.1208,-91.1365,SOME,OTHER,NAME
</screen>
-</section>
-
-<section id="style_const_comments">
-<title>COMMENTS</title>
-<para>
-Anything after a hash (#) on a line is not parsed. For example:
+ </section>
+ <section id="style_const_comments">
+ <title>COMMENTS</title>
+ <para>Anything after a hash (#) on a line is not parsed. For example:
</para>
-<screen format="linespecific">#THIS ENTIRE LINE IS A COMMENT.
-#FIELD LAT_DECIMAL, "", "%f" THIS ENTIRE LINE IS A COMMENT
-FIELD LAT_DECIMAL, "", "%f" # ONLY THIS SENTENCE IS A COMMENT.
+ <screen format="linespecific">#THIS ENTIRE LINE IS A COMMENT.
+#FIELD LAT_DECIMAL, "", "%f" THIS ENTIRE LINE IS A COMMENT
+FIELD LAT_DECIMAL, "", "%f" # ONLY THIS SENTENCE IS A COMMENT.
</screen>
-</section>
-</section> <!-- internal constants -->
-
-<section id="style_global">
-<title>Global Properties of the File</title>
-<para>
-There are a few available directives to describe general traits of the
+ </section>
+ </section>
+ <!-- internal constants -->
+ <section id="style_global">
+ <title>Global Properties of the File</title>
+ <para>There are a few available directives to describe general traits of the
file being described and not specific data within the file itself.
</para>
-<section id="style_global_description">
-<title>DESCRIPTION</title>
-<para>
-This is the description of the file format being described. This text
+ <section id="style_global_description">
+ <title>DESCRIPTION</title>
+ <para>This is the description of the file format being described. This text
appears in the help screens and in menus used by the various GUI wrappers.
</para>
-</section>
-<section id="style_global_extension">
-<title>EXTENSION</title>
-<para>
-This directive gives the filename extension generally associated with
+ </section>
+ <section id="style_global_extension">
+ <title>EXTENSION</title>
+ <para>This directive gives the filename extension generally associated with
this file.
</para>
-</section>
-<section id="style_global_encoding">
-<title>ENCODING</title>
-<para>
-Describes the character set used by this format. The value given
+ </section>
+ <section id="style_global_encoding">
+ <title>ENCODING</title>
+ <para>Describes the character set used by this format. The value given
must be one listed by 'gpsbabel -l'. example:
</para>
-<screen format="linespecific"> ENCODING UTF-8 # Use UTF-8 for input and output.
+ <screen format="linespecific">ENCODING UTF-8 # Use UTF-8 for input and output.
</screen>
-</section>
-<section id="style_global_datum">
-<title>DATUM</title>
-<para>
-This value specifies the GPS datum to be used on read or write. Valid values for this
-option are listed in <xref linkend="Datums" />.
-</para>
-<screen format="linespecific"> DATUM European 1950
+ </section>
+ <section id="style_global_datum">
+ <title>DATUM</title>
+ <para>This value specifies the GPS datum to be used on read or write. Valid values for this
+option are listed in
+
+
+
+
+
+
+ <xref linkend="Datums"/>
+ .</para>
+ <screen format="linespecific">DATUM European 1950
</screen>
-</section>
-<section id="style_global_datatype">
-<title>DATATYPE</title>
-<para>
-Specifies the kind of data we have to read or write.
+ </section>
+ <section id="style_global_datatype">
+ <title>DATATYPE</title>
+ <para>Specifies the kind of data we have to read or write.
</para>
-<para>
-By default all data are seen as waypoint data. With DATATYPE you are now able to bind
+ <para>By default all data are seen as waypoint data. With DATATYPE you are now able to bind
a specific type to this format. Possible values are WAYPOINT, ROUTE or TRACK.
</para>
-<screen format="linespecific"> DATATYPE ROUTE # route-only format
+ <screen format="linespecific">DATATYPE ROUTE # route-only format
</screen>
-</section>
-</section> <!-- global -->
-
-<section id="style_behavior">
-<title>GPSBabel Behavior Directives</title>
-<para>
-There are a few available directives to control some of the internal
+ </section>
+ </section>
+ <!-- global -->
+ <section id="style_behavior">
+ <title>GPSBabel Behavior Directives</title>
+ <para>There are a few available directives to control some of the internal
processing functions of GPSBabel.
</para>
-<section id="style_behave_shortlen">
-<title>SHORTLEN</title>
-<para>
- This sets the maximum allowed shortname length when using the internal
+ <section id="style_behave_shortlen">
+ <title>SHORTLEN</title>
+ <para>This sets the maximum allowed shortname length when using the internal
shortname synthesizer.
</para>
-<para>
- example:
+ <para>example:
</para>
-<screen format="linespecific"> SHORTLEN 16 # shortnames will be at most 16 characters long.
+ <screen format="linespecific">SHORTLEN 16 # shortnames will be at most 16 characters long.
</screen>
-</section>
-
-<section id="style_behave_shortwhite">
-<title>SHORTWHITE</title>
-<para>
- This tells the shortname synthesizer whether or not to allow whitespace
+ </section>
+ <section id="style_behave_shortwhite">
+ <title>SHORTWHITE</title>
+ <para>This tells the shortname synthesizer whether or not to allow whitespace
in the synthesized shortnames. Allowed values are zero and one.
</para>
-<para>
- example:
+ <para>example:
</para>
-<screen format="linespecific"> SHORTWHITE 0 # Do not allow whitespace in shortname.
- SHORTWHITE 1 # Allow whitespace in shortname.
+ <screen format="linespecific">SHORTWHITE 0 # Do not allow whitespace in shortname.
+ SHORTWHITE 1 # Allow whitespace in shortname.
</screen>
-</section>
-</section> <!-- behavior -->
-
-<section id="style_layout">
-<title>Defining the Layout of the File</title>
-<para>
-The first few directives define the layout the physical file itself:
+ </section>
+ </section>
+ <!-- behavior -->
+ <section id="style_layout">
+ <title>Defining the Layout of the File</title>
+ <para>The first few directives define the layout the physical file itself:
</para>
-
-<section id="style_layout_field">
-<title>FIELD_DELIMITER</title>
-<para>
- The field delimiter defines the character(s) that separate the fields in
- the rows of data inside the XCSV file. Common field delimiters are commas
- and tabs. (referred to as "comma separated values" and "tab separated
- values")
+ <section id="style_layout_field">
+ <title>FIELD_DELIMITER</title>
+ <para>The field delimiter defines the character(s) that separate the fields in
+ the rows of data inside the XCSV file. Common field delimiters are commas
+ and tabs. (referred to as "comma separated values" and "tab separated
+ values")
</para>
-<para>
- examples:
+ <para>examples:
</para>
-<screen format="linespecific"> FIELD_DELIMITER COMMA
+ <screen format="linespecific">FIELD_DELIMITER COMMA
FIELD_DELIMITER ~
</screen>
-<para>
- The directive FIELD_DELIMITER is parsed for STYLE CONSTANTS as defined in
+ <para>The directive FIELD_DELIMITER is parsed for STYLE CONSTANTS as defined in
the table above.
</para>
-</section>
-
-<section id="style_layout_field_enclose">
-<title>FIELD_ENCLOSER</title>
-<para>
- The field encloser defines the character(s) that surround the field values.
+ </section>
+ <section id="style_layout_field_enclose">
+ <title>FIELD_ENCLOSER</title>
+ <para>The field encloser defines the character(s) that surround the field values.
Common field enclosers are single and double quote marks. Many styles will
leave this directive unset. If set, it will be applied to all fields.
</para>
-<para>
- examples:
+ <para>examples:
</para>
-<screen format="linespecific"> FIELD_ENCLOSER DOUBLEQUOTE
+ <screen format="linespecific">FIELD_ENCLOSER DOUBLEQUOTE
FIELD_ENCLOSER SINGLEQUOTE
</screen>
-<para>
- The directive FIELD_ENCLOSER is parsed for STYLE CONSTANTS as defined in
+ <para>The directive FIELD_ENCLOSER is parsed for STYLE CONSTANTS as defined in
the table above.
</para>
-</section>
-
-<section id="style_layout_rec">
-<title>RECORD_DELIMITER</title>
-<para>
- The record delimiter defines that character(s) that separate ROWS of
+ </section>
+ <section id="style_layout_rec">
+ <title>RECORD_DELIMITER</title>
+ <para>The record delimiter defines that character(s) that separate ROWS of
data (FIELDS) in the XCSV file. The most common record delimiters
are NEWLINE and CR (carriage return).
</para>
-<para>
- examples:
+ <para>examples:
</para>
-<screen format="linespecific"> RECORD_DELIMITER NEWLINE
+ <screen format="linespecific">RECORD_DELIMITER NEWLINE
RECORD_DELIMITER |
</screen>
-<para>
- The directive RECORD_DELIMITER is parsed for STYLE CONSTANTS as defined
+ <para>The directive RECORD_DELIMITER is parsed for STYLE CONSTANTS as defined
in the table above.
</para>
-</section>
-
-<section id="style_layout_badchars">
-<title>BADCHARS</title>
-<para>
- Bad characters are things that should *never* be written into the XCSV
+ </section>
+ <section id="style_layout_badchars">
+ <title>BADCHARS</title>
+ <para>Bad characters are things that should *never* be written into the XCSV
file as data on output. GPSBabel automatically includes any non-blank
FIELD_DELIMITER and FIELD_ENCLOSER and RECORD_DELIMITER characters as
BADCHARS by default.
</para>
-<para>
- examples:
+ <para>examples:
</para>
-<screen format="linespecific"> BADCHARS COMMA
+ <screen format="linespecific">BADCHARS COMMA
BADCHARS ~|
</screen>
-<para>
- The directive BADCHARS is parsed for STYLE CONSTANTS as defined in the
+ <para>The directive BADCHARS is parsed for STYLE CONSTANTS as defined in the
table above.
</para>
-</section>
-
-<section id="style_layout_prologue">
-<title>PROLOGUE</title>
-<para>
- A prologue is basically constant data that is written to the output
- file BEFORE any waypoints are processed. PROLOGUE can be defined
- multiple times in the style file, once for each "line" before the data
- begins. This is commonly used in XCSV files as a "header" row.
+ </section>
+ <section id="style_layout_prologue">
+ <title>PROLOGUE</title>
+ <para>A prologue is basically constant data that is written to the output
+ file BEFORE any waypoints are processed. PROLOGUE can be defined
+ multiple times in the style file, once for each "line" before the data
+ begins. This is commonly used in XCSV files as a "header" row.
</para>
-<para>
- examples:
+ <para>examples:
</para>
-<screen format="linespecific"> PROLOGUE OziExplorer Waypoint File Version 1.1
- PROLOGUE WGS 84
- PROLOGUE Symbol,Name,Latitude,Longitude
+ <screen format="linespecific">PROLOGUE OziExplorer Waypoint File Version 1.1
+ PROLOGUE WGS 84
+ PROLOGUE Symbol,Name,Latitude,Longitude
</screen>
-</section>
-
-<section id="style_layout_epilogue">
-<title>EPILOGUE</title>
-<para>
- An Epilogue is the same as a prologue, except this data is written at
+ </section>
+ <section id="style_layout_epilogue">
+ <title>EPILOGUE</title>
+ <para>An Epilogue is the same as a prologue, except this data is written at
the END of the file. See the examples for PROLOGUE above.
</para>
-</section>
-</section> <!-- layout -->
-
-<section id="style_define">
-<title>Defining Fields Within the File</title>
-<para>
-A field defines data. There are two different classifications of FIELDS,
+ </section>
+ </section>
+ <!-- layout -->
+ <section id="style_define">
+ <title>Defining Fields Within the File</title>
+ <para>A field defines data. There are two different classifications of FIELDS,
IFIELD (file input) and OFIELD (file output). In the absence of any OFIELDS,
-IFIELDS are use as both input and output. The existence of OFIELDS is
-primarily to allow more flexible mapping of GPSBabel data to output data
-(say, for instance, to map the internal GPSBabel "description" variable to
-two or more fields on output). For all practical purposes, IFIELDS and
+IFIELDS are use as both input and output. The existence of OFIELDS is
+primarily to allow more flexible mapping of GPSBabel data to output data
+(say, for instance, to map the internal GPSBabel "description" variable to
+two or more fields on output). For all practical purposes, IFIELDS and
OFIELDS are defined the same way in the style file.</para>
-<para>The following per-field options are defined:
+
<para>The following per-field options are defined:
</para>
-<itemizedlist>
-<listitem>
-<para>
- "no_delim_before" is supported on in OFIELD tags to specify that this
+ <itemizedlist>
+ <listitem>
+ <para>"no_delim_before" is supported on in OFIELD tags to specify that this
field should be written without a field delimiter before it. It's
useful for limited field concatenation.
</para>
-</listitem>
-
-<listitem>
-<para>
- "absolute" is supported on OFIELD tags for lat and lon to indicate
+ </listitem>
+ <listitem>
+ <para>"absolute" is supported on OFIELD tags for lat and lon to indicate
that only absolute values (never negative) are to be printed.
</para>
-</listitem>
-
-<listitem>
-<para>
- "optional" is supported only OFIELD tags and indicates that the
+ </listitem>
+ <listitem>
+ <para>"optional" is supported only OFIELD tags and indicates that the
field may or may not be available in the source data. If the
field is absent, no trailing field separator is written.
</para>
-<para>
- This attribute is most useful when paired with "no_delim_before" as
+ <para>This attribute is most useful when paired with "no_delim_before" as
it allows you to concatenate fields without concern for whether those
fields are actually populated or not.
</para>
-</listitem>
-
-</itemizedlist>
-
-<para>
-There are several different types of fields that may be defined. Each field
-consists of three pieces of information: the FIELD TYPE, a DEFAULT VALUE, and
+ </listitem>
+ </itemizedlist>
+ <para>There are several different types of fields that may be defined. Each field
+consists of three pieces of information: the FIELD TYPE, a DEFAULT VALUE, and
a PRINTF CONVERSION (for output). In many cases, not all pieces are used,
but all 3 pieces are required. Additionally, an fourth field is supported
that modifies the behaviour of the field being described.
</para>
-<para>
-FIELDS should be defined in the style file in the logical order that they
+ <para>FIELDS should be defined in the style file in the logical order that they
appear in the data, from left to right. This is the order in which they are
parsed from input and written to output.
</para>
-<para>
-The fields used by the XCSV parser are as follows:
+ <para>The fields used by the XCSV parser are as follows:
</para>
-
-<section id="style_def_ignore">
-<title>IGNORE</title>
-<para>
- IGNORE fields are, guess what, ignored on input. Internally, IGNORE
- fields are treated as CHARACTER data, and as such, require a printf
- conversion for a character array.
+ <section id="style_def_ignore">
+ <title>IGNORE</title>
+ <para>IGNORE fields are, guess what, ignored on input. Internally, IGNORE
+ fields are treated as CHARACTER data, and as such, require a printf
+ conversion for a character array.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific"> IFIELD IGNORE,"","%14.14s" # (writes a 14 character blank field)
- IFIELD IGNORE,"","%s" # (writes a blank field on output)
+ <screen format="linespecific">IFIELD IGNORE,"","%14.14s" # (writes a 14 character blank field)
+ IFIELD IGNORE,"","%s" # (writes a blank field on output)
</screen>
-</section>
-
-<section id="style_def_constant">
-<title>CONSTANT</title>
-<para>
- CONSTANT fields are, of course, constant. They are ignored on input,
- however they write CONSTANT data on output. As such, they require a
- DEFAULT VALUE and a printf conversion for a character array.
+ </section>
+ <section id="style_def_constant">
+ <title>CONSTANT</title>
+ <para>CONSTANT fields are, of course, constant. They are ignored on input,
+ however they write CONSTANT data on output. As such, they require a
+ DEFAULT VALUE and a printf conversion for a character array.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific"> IFIELD CONSTANT,"FFFFFF","%s" # (writes "FFFFFF" in the field)
- IFIELD CONSTANT,"01/01/70","%s" # (a constant date field)
+ <screen format="linespecific">IFIELD CONSTANT,"FFFFFF","%s" # (writes "FFFFFF" in the field)
+ IFIELD CONSTANT,"01/01/70","%s" # (a constant date field)
</screen>
-</section>
-
-<section id="style_def_index">
-<title>INDEX</title>
-<para>
- An INDEX field is used ONLY on output. The INDEX constant defines a field
- that, at output, contains the sequence number of the waypoint being
- written, starting at 0. An index is managed internally as an INTEGER
+ </section>
+ <section id="style_def_index">
+ <title>INDEX</title>
+ <para>An INDEX field is used ONLY on output. The INDEX constant defines a field
+ that, at output, contains the sequence number of the waypoint being
+ written, starting at 0. An index is managed internally as an INTEGER
and requires an INTEGER printf conversion. An INDEX has one special
- property. The DEFAULT VALUE of the index is added to the index
- on each iteration (to allow indexes starting at 1, 100, etc..).
+ property. The DEFAULT VALUE of the index is added to the index
+ on each iteration (to allow indexes starting at 1, 100, etc..).
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific"> IFIELD INDEX,"0","%04d" # (Starts counting at zero)
- IFIELD INDEX,"","%04d" # (Starts counting at zero)
- IFIELD INDEX,"1","%04d" # (Starts counting at one)
+ <screen format="linespecific">IFIELD INDEX,"0","%04d" # (Starts counting at zero)
+ IFIELD INDEX,"","%04d" # (Starts counting at zero)
+ IFIELD INDEX,"1","%04d" # (Starts counting at one)
</screen>
-</section>
-
-<section id="style_def_shortname">
-<title>SHORTNAME</title>
-<para>
- A SHORTNAME is generally the waypoint name of the data being processed.
- SHORTNAME maps directly to the GPSBabel variable ->shortname. A SHORTNAME
+ </section>
+ <section id="style_def_shortname">
+ <title>SHORTNAME</title>
+ <para>A SHORTNAME is generally the waypoint name of the data being processed.
+ SHORTNAME maps directly to the GPSBabel variable ->shortname. A SHORTNAME
is CHARACTER data and requires a character array printf conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD SHORTNAME,"","%s"
+ <screen format="linespecific">IFIELD SHORTNAME,"","%s"
</screen>
-</section>
-
-<section id="style_def_description">
-<title>DESCRIPTION</title>
-<para>
- A DESCRIPTION is generally a long description of the waypoint. A
- DESCRIPTION maps to the GPSBabel variable ->description and is otherwise
+ </section>
+ <section id="style_def_description">
+ <title>DESCRIPTION</title>
+ <para>A DESCRIPTION is generally a long description of the waypoint. A
+ DESCRIPTION maps to the GPSBabel variable ->description and is otherwise
handled exactly like a SHORTNAME.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific"> IFIELD DESCRIPTION,"","%s"
+ <screen format="linespecific">IFIELD DESCRIPTION,"","%s"
</screen>
-</section>
-
-<section id="style_def_notes">
-<title>NOTES</title>
-<para>
- NOTES are generally everything else about a waypoints. NOTES map to the
- GPSBabel variable ->notes and is otherwise handled exactly like a
+ </section>
+ <section id="style_def_notes">
+ <title>NOTES</title>
+ <para>NOTES are generally everything else about a waypoints. NOTES map to the
+ GPSBabel variable ->notes and is otherwise handled exactly like a
SHORTNAME.
</para>
-</section>
-
-<section id="style_def_url">
-<title>URL</title>
-<para>
- URL is a URL for the waypoint. URL maps to the GPSBabel variable
- ->url and is otherwise handled exactly like a SHORTNAME.
+ </section>
+ <section id="style_def_url">
+ <title>URL</title>
+ <para>URL is a URL for the waypoint. URL maps to the GPSBabel variable
+ ->url and is otherwise handled exactly like a SHORTNAME.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD URL,"","%s"
+ <screen format="linespecific">IFIELD URL,"","%s"
</screen>
-</section>
-
-<section id="style_def_urllinktext">
-<title>URL_LINK_TEXT</title>
-<para>
- URL_LINK_TEXT is a textual description of where a URL points.
- URL_LINK_TEXT maps to the GPSBabel variable ->url_link_text and
+ </section>
+ <section id="style_def_urllinktext">
+ <title>URL_LINK_TEXT</title>
+ <para>URL_LINK_TEXT is a textual description of where a URL points.
+ URL_LINK_TEXT maps to the GPSBabel variable ->url_link_text and
is otherwise handled exactly like a SHORTNAME.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD URL_LINK_TEXT,"","%s"
+ <screen format="linespecific">IFIELD URL_LINK_TEXT,"","%s"
</screen>
-</section>
-
-<section id="style_def_icondescr">
-<title>ICON_DESCR</title>
-<para>
- ICON_DESCR is a textual description of an icon type for a waypoint.
- ICON_DESCR maps to the GPSBabel variable ->icon_desc and is otherwise
+ </section>
+ <section id="style_def_icondescr">
+ <title>ICON_DESCR</title>
+ <para>ICON_DESCR is a textual description of an icon type for a waypoint.
+ ICON_DESCR maps to the GPSBabel variable ->icon_desc and is otherwise
handled exactly like a SHORTNAME.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD ICON_DESCR,"","%s"
+ <screen format="linespecific">IFIELD ICON_DESCR,"","%s"
</screen>
-</section>
-
-<section id="style_def_latdec">
-<title>LAT_DECIMAL</title>
-<para>
- LAT_DECIMAL defines LATITUDE in DECIMAL format. Note that this is a PURE
- signed decimal format (i.e. -91.0000). This data is handled internally as
+ </section>
+ <section id="style_def_latdec">
+ <title>LAT_DECIMAL</title>
+ <para>LAT_DECIMAL defines LATITUDE in DECIMAL format. Note that this is a PURE
+ signed decimal format (i.e. -91.0000). This data is handled internally as
a DOUBLE PRECISION FLOAT and requires a FLOATING POINT printf conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD LAT_DECIMAL,"","%f"
+ <screen format="linespecific">IFIELD LAT_DECIMAL,"","%f"
</screen>
-</section>
-
-
-<section id="style_def_londec">
-<title>LON_DECIMAL</title>
-<para>
- See LAT_DECIMAL, except LON_DECIMAL defines LONGITUDE.
+ </section>
+ <section id="style_def_londec">
+ <title>LON_DECIMAL</title>
+ <para>See LAT_DECIMAL, except LON_DECIMAL defines LONGITUDE.
</para>
-</section>
-
-<section id="style_def_latint32">
-<title>LAT_INT32DEG</title>
-<para>
- LAT_INT32DEG defines LATITUDE in what I call INT32DEGREES. This value is
+ </section>
+ <section id="style_def_latint32">
+ <title>LAT_INT32DEG</title>
+ <para>LAT_INT32DEG defines LATITUDE in what I call INT32DEGREES. This value is
a signed LONG INTEGER and requires a LONG INTEGER printf conversion.
(This format is only used by some DeLorme products.)
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD LAT_INT32DEG,"","%ld"
+ <screen format="linespecific">IFIELD LAT_INT32DEG,"","%ld"
</screen>
-</section>
-
-<section id="style_def_lonint32">
-<title>LON_INT32DEG</title>
-<para>
- See LON_INT32DEG except LON_INT32DEG defines LONGITUDE.
+ </section>
+ <section id="style_def_lonint32">
+ <title>LON_INT32DEG</title>
+ <para>See LON_INT32DEG except LON_INT32DEG defines LONGITUDE.
</para>
-</section>
-
-<section id="style_def_latdirdec">
-<title>LAT_DECIMALDIR / LAT_DIRDECIMAL</title>
-<para>
- LAT_DECIMALDIR and LAT_DIRDECIMAL define LATITUDE in DECIMAL format
- with the added bonus of a 'N/S' or 'E/W' direction character. This data
- is handled internally as a DOUBLE PRECISION FLOAT and a single
- CHARACTER and requires a FLOATING POINT as well as a CHARACTER printf
+ </section>
+ <section id="style_def_latdirdec">
+ <title>LAT_DECIMALDIR / LAT_DIRDECIMAL</title>
+ <para>LAT_DECIMALDIR and LAT_DIRDECIMAL define LATITUDE in DECIMAL format
+ with the added bonus of a 'N/S' or 'E/W' direction character. This data
+ is handled internally as a DOUBLE PRECISION FLOAT and a single
+ CHARACTER and requires a FLOATING POINT as well as a CHARACTER printf
conversion. The only difference between the two is whether the directional
character appears before (LAT_DIRDECIMAL) or after (LAT_DECIMALDIR) the
decimal number.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific"> IFIELD LAT_DECIMALDIR,"","%f %c" # (writes 31.333 N)
- IFIELD LAT_DIRDECIMAL,"","%c %f" # (writes N 31.333)
+ <screen format="linespecific">IFIELD LAT_DECIMALDIR,"","%f %c" # (writes 31.333 N)
+ IFIELD LAT_DIRDECIMAL,"","%c %f" # (writes N 31.333)
</screen>
-</section>
-
-<section id="style_def_londirdec">
-<title>LON_DECIMALDIR / LON_DIRDECIMAL</title>
-<para>
- Same as LAT_DECIMALDIR / LAT_DIRDECIMAL except LON_ defines LONGITUDE.
+ </section>
+ <section id="style_def_londirdec">
+ <title>LON_DECIMALDIR / LON_DIRDECIMAL</title>
+ <para>Same as LAT_DECIMALDIR / LAT_DIRDECIMAL except LON_ defines LONGITUDE.
</para>
-</section>
-
-<section id="style_def_latlondir">
-<title>LAT_DIR / LON_DIR</title>
-<para>
- LAT_DIR returns the single character 'N' or 'S' depending on the
+ </section>
+ <section id="style_def_latlondir">
+ <title>LAT_DIR / LON_DIR</title>
+ <para>LAT_DIR returns the single character 'N' or 'S' depending on the
hemisphere of the latitude. LON_DIR returns 'E' or 'W' depending on
the hemisphere of the longitude.
</para>
-</section>
-
-<section id="style_def_lathuman">
-<title>LAT_HUMAN_READABLE</title>
-<para>
- LAT_HUMAN_READABLE defines LATITUDE in a human-readable format. This
- format is probably the most expressive format. It is similar to
+ </section>
+ <section id="style_def_lathuman">
+ <title>LAT_HUMAN_READABLE</title>
+ <para>LAT_HUMAN_READABLE defines LATITUDE in a human-readable format. This
+ format is probably the most expressive format. It is similar to
LAT_DECIMALDIR in that it requires multiple printf conversions, but it
is far more flexible as to the contents of those conversions. On read,
the printf conversions are ignored and GPSBabel attempts to determine the
latitude and longitude based on what is in the file.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific">
- # (writes N 31 40.000)
- IFIELD LAT_HUMAN_READABLE,"","%c %d %f"
- # (writes "31 deg 40.000 min N")
- IFIELD LAT_HUMAN_READABLE,"","%d deg %f min %c"
- # Note that this string will confuse the reading routine due
- # to the letter "n" in "min" and the letter "e" in "deg."
+ <screen format="linespecific"># (writes N 31 40.000)
+ IFIELD LAT_HUMAN_READABLE,"","%c %d %f"
+ # (writes "31 deg 40.000 min N")
+ IFIELD LAT_HUMAN_READABLE,"","%d deg %f min %c"
+ # Note that this string will confuse the reading routine due
+ # to the letter "n" in "min" and the letter "e" in "deg."
# (writes 31 40 00.000N)
- IFIELD LAT_HUMAN_READABLE,"","%d %d %f%c"
+ IFIELD LAT_HUMAN_READABLE,"","%d %d %f%c"
</screen>
-</section>
-
-<section id="style_def_map_en_bng">
-<title>MAP_EN_BNG</title>
-<para>
- MAP_EN_BNG converts coordinates from/to British National Grid (BNG).
+ </section>
+ <section id="style_def_map_en_bng">
+ <title>MAP_EN_BNG</title>
+ <para>MAP_EN_BNG converts coordinates from/to British National Grid (BNG).
</para>
-<para>
- The only supported order of the items is: Map,Easting,Northing.
+ <para>The only supported order of the items is: Map,Easting,Northing.
During output all coordinates have to be located within this limited area.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific">
- IFIELD MAP_EN_BNG,"","%s%5d %5d" # (writes i.e. "SJ00001 00001")
- IFIELD MAP_EN_BNG,"","%s %d %d" # (writes i.e. "TQ 888 999")
+ <screen format="linespecific">IFIELD MAP_EN_BNG,"","%s%5d %5d" # (writes i.e. "SJ00001 00001")
+ IFIELD MAP_EN_BNG,"","%s %d %d" # (writes i.e. "TQ 888 999")
</screen>
-</section>
-
-<section id="style_def_lonhuman">
-<title>LON_HUMAN_READABLE</title>
-<para>
- See LAT_HUMAN_READABLE except LON_HUMAN_READABLE defines LONGITUDE.
+ </section>
+ <section id="style_def_lonhuman">
+ <title>LON_HUMAN_READABLE</title>
+ <para>See LAT_HUMAN_READABLE except LON_HUMAN_READABLE defines LONGITUDE.
</para>
-</section>
-
-<section id="style_def_latlonhuman">
-<title>LATLON_HUMAN_READABLE</title>
-<para>
- LATLON_HUMAN_READABLE is like LAT_HUMAN_READABLE and LON_HUMAN_READABLE
- except that it reads and writes both latitude and longitude as a single
+ </section>
+ <section id="style_def_latlonhuman">
+ <title>LATLON_HUMAN_READABLE</title>
+ <para>LATLON_HUMAN_READABLE is like LAT_HUMAN_READABLE and LON_HUMAN_READABLE
+ except that it reads and writes both latitude and longitude as a single
field. On write, the same format specifier is used for both coordinates.
- On read, GPSBabel does exactly the same thing it does for
+ On read, GPSBabel does exactly the same thing it does for
LAT_HUMAN_READABLE or LON_HUMAN_READABLE.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD LATLON_HUMAN_READABLE,"","%c %d %f"
- # (writes "N 31 40.126 W 85 09.62" as a single field)
+ <screen format="linespecific">IFIELD LATLON_HUMAN_READABLE,"","%c %d %f"
+ # (writes "N 31 40.126 W 85 09.62" as a single field)
</screen>
-</section>
-
-<section id="style_def_latnmea">
-<title>LAT_NMEA</title>
-<para>
- Defines the latitude in the format used by the NMEA standard which is
+ </section>
+ <section id="style_def_latnmea">
+ <title>LAT_NMEA</title>
+ <para>Defines the latitude in the format used by the NMEA standard which is
degrees multiplied by 100 plus decimal minutes.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD LAT_NMEA, "%f", "%08.3f" # (writes 3558.322)
+ <screen format="linespecific">IFIELD LAT_NMEA, "%f", "%08.3f" # (writes 3558.322)
</screen>
-</section>
-
-<section id="style_def_latddmmdir">
-<title>LAT_DDMMDIR</title>
-<para>
-Derived from the LAT_NMEA latitude format, with degrees * 100 plus decimal
-minutes, but using an additional specifier to position the 'N' or 'S' instead of a leading minus sign (or
+ </section>
+ <section id="style_def_latddmmdir">
+ <title>LAT_DDMMDIR</title>
+ <para>Derived from the LAT_NMEA latitude format, with degrees * 100 plus decimal
+minutes, but using an additional specifier to position the 'N' or 'S' instead of a leading minus sign (or
absence thereof) to give direction from zero.
</para>
-<para>
-<screen format="linespecific"> IFIELD LAT_DDMMDIR, "%f", "%08.3f%c" # (writes "5334.192S" giving -53.56987 degrees latitude)
+ <screen format="linespecific">IFIELD LAT_DDMMDIR, "%f", "%08.3f%c" # (writes "5334.192S" giving -53.56987 degrees latitude)
</screen>
-</para>
-</section>
-
-
-
-
-<section id="style_def_lonnmea">
-<title>LON_NMEA</title>
-<para>
- Defines the longitude in the format used by the NMEA standard which is
+ </para>
+ </section>
+ <section id="style_def_lonnmea">
+ <title>LON_NMEA</title>
+ <para>Defines the longitude in the format used by the NMEA standard which is
degrees multiplied by 100 plus decimal minutes.
</para>
-<para>
-Example:
+ <para>Example:
</para>
-<screen format="linespecific"> IFIELD LON_NMEA, "%f", "%010.3f" # (writes -08708.082)
+ <screen format="linespecific">IFIELD LON_NMEA, "%f", "%010.3f" # (writes -08708.082)
</screen>
-</section>
-
-<section id="style_def_londdmmdir">
-<title>LON_DDMMDIR</title>
-<para>
-Derived from the LON_NMEA longitude format, with degrees * 100 plus decimal minutes, but using an additional character format character to position the
+ </section>
+ <section id="style_def_londdmmdir">
+ <title>LON_DDMMDIR</title>
+ <para>Derived from the LON_NMEA longitude format, with degrees * 100 plus decimal minutes, but using an additional character format character to position the
'E' or 'W' instead of a leading minus sign (or absence thereof) to give direction from zero.
</para>
-<para>
-Example:
+ <para>Example:
</para>
-<screen format="linespecific"> IFIELD LON_DDMMDIR, "%f", "%010.3f%c" # (writes "01232.745W" giving -12.54575 degrees
+ <screen format="linespecific">IFIELD LON_DDMMDIR, "%f", "%010.3f%c" # (writes "01232.745W" giving -12.54575 degrees
longitude)
</screen>
-</section>
-
-
-<section id="style_def_latlon_10ex">
-<title>LAT_10EX / LON_10EX</title>
-<para>
- Defines the latitude or longitude in the format used i.e. by TomTom Navigator
+ </section>
+ <section id="style_def_latlon_10ex">
+ <title>LAT_10EX / LON_10EX</title>
+ <para>Defines the latitude or longitude in the format used i.e. by TomTom Navigator
itinerary files. It is degrees multiplied by 10 power X. X have to be replaced with
a valid decimal value. A factor of 10000 would be generated by LAT_10E5 as shown
in the examples below.
</para>
-<para>
-examples:
+ <para>examples:
</para>
-<screen format="linespecific"> IFIELD LAT_10E5, "%f", "%.f" # (writes 3558322)
+ <screen format="linespecific">IFIELD LAT_10E5, "%f", "%.f" # (writes 3558322)
</screen>
-<screen format="linespecific"> IFIELD LON_10E5, "%f", "%.f" # (writes -8708082)
+ <screen format="linespecific">IFIELD LON_10E5, "%f", "%.f" # (writes -8708082)
</screen>
-</section>
-
-<section id="style_def_utm">
-<title>UTM</title>
-<para>A location in UTM has several components: a zone, a northing, and an easting. The UTM format specifier is the most common representation of these.
+ </section>
+ <section id="style_def_utm">
+ <title>UTM</title>
+ <para>A location in UTM has several components: a zone, a northing, and an easting. The UTM format specifier is the most common representation of these.
</para>
-<para>example: </para>
-<screen format="linespecific">
-IFIELD UTM, "", "%s" # writes 6S 519045 3984035 -the easting is first by convention.</screen>
-</section>
-
-<section id="style_def_utm_easting">
-<title>UTM_EASTING</title>
-<para>This is the decimal component representing the easting
+ <para>example: </para>
+ <screen format="linespecific">IFIELD UTM, "", "%s" # writes 6S 519045 3984035 -the easting is first by convention.</screen>
+ </section>
+ <section id="style_def_utm_easting">
+ <title>UTM_EASTING</title>
+ <para>This is the decimal component representing the easting
</para>
-<para>example: </para>
-<screen format="linespecific">
-IFIELD UTM_EASTING, "", "%.0f" # outputs 519045
+ <para>example: </para>
+ <screen format="linespecific">IFIELD UTM_EASTING, "", "%.0f" # outputs 519045
</screen>
-</section>
-
-<section id="style_def_utm_northing">
-<title>UTM_NORTHING</title>
-<para>
-This is the decimal component representing the northing
+ </section>
+ <section id="style_def_utm_northing">
+ <title>UTM_NORTHING</title>
+ <para>This is the decimal component representing the northing
</para>
-<para>example: </para>
-<screen format="linespecific">
-IFIELD UTM_NORTHING "", "%.0f" # outputs 3984035
+ <para>example: </para>
+ <screen format="linespecific">IFIELD UTM_NORTHING "", "%.0f" # outputs 3984035
</screen>
-</section>
-
-<section id="style_def_utm_zone">
-<title>UTM_ZONE</title>
-<para>The UTM zone.
+ </section>
+ <section id="style_def_utm_zone">
+ <title>UTM_ZONE</title>
+ <para>The UTM zone.
</para>
-<para>example: </para>
-<screen format="linespecific">
-IFIELD UTM_ZONE "", "%d" # outputs 6
+ <para>example: </para>
+ <screen format="linespecific">IFIELD UTM_ZONE "", "%d" # outputs 6
</screen>
-</section>
-
-<section id="style_def_utm_zonec">
-<title>UTM_ZONEC</title>
-<para>
-The UTM Zone character.
+ </section>
+ <section id="style_def_utm_zonec">
+ <title>UTM_ZONEC</title>
+ <para>The UTM Zone character.
</para>
-<para>example: </para>
-<screen format="linespecific">
-IFIELD UTM_ZONEC "", "%c" # outputs S
+ <para>example: </para>
+ <screen format="linespecific">IFIELD UTM_ZONEC "", "%c" # outputs S
</screen>
-</section>
-
-<section id="style_def_utm_zonef">
-<title></title>
-<para>
-The full UTM zone and latitude band.
+ </section>
+ <section id="style_def_utm_zonef">
+ <title/>
+ <para>The full UTM zone and latitude band.
</para>
-<para>example: </para>
-<screen format="linespecific">
-IFIELD UTM_ZONEF "", "%d%c" # outputs 6S
+ <para>example: </para>
+ <screen format="linespecific">IFIELD UTM_ZONEF "", "%d%c" # outputs 6S
</screen>
-</section>
-
-
-<section id="style_def_altfeet">
-<title>ALT_FEET</title>
-<para>
- ALT_FEET is the position's ALTITUDE in FEET. This value is treated as
- a SIGNED DOUBLE PRECISION FLOAT and requires a FLOATING POINT printf
+ </section>
+ <section id="style_def_altfeet">
+ <title>ALT_FEET</title>
+ <para>ALT_FEET is the position's ALTITUDE in FEET. This value is treated as
+ a SIGNED DOUBLE PRECISION FLOAT and requires a FLOATING POINT printf
conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD ALT_FEET,"","%.0f"
+ <screen format="linespecific">IFIELD ALT_FEET,"","%.0f"
</screen>
-</section>
-
-<section id="style_def_altmeters">
-<title>ALT_METERS</title>
-<para>
- ALT_METERS is identical to ALT_FEET with the exception that the altitude
+ </section>
+ <section id="style_def_altmeters">
+ <title>ALT_METERS</title>
+ <para>ALT_METERS is identical to ALT_FEET with the exception that the altitude
is in METERS.
</para>
-</section>
-
-<section id="style_def_heartrate">
-<title>HEART_RATE</title>
-<para>
- Heart rate, measured in beats per minute. Only valid for units with
+ </section>
+ <section id="style_def_heartrate">
+ <title>HEART_RATE</title>
+ <para>Heart rate, measured in beats per minute. Only valid for units with
heart rate monitor features (i.e. Garmin Forerunner 301).
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD HEART_RATE,"","%d"
+ <screen format="linespecific">IFIELD HEART_RATE,"","%d"
</screen>
-</section>
-
-<section id="style_def_cadence">
-<title>CADENCE</title>
-<para>
- Cadence in revolutions per minute. Only valid for units with
+ </section>
+ <section id="style_def_cadence">
+ <title>CADENCE</title>
+ <para>Cadence in revolutions per minute. Only valid for units with
heart rate monitor features (i.e. Garmin Edge 305).
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD CADENCE,"","%d"
+ <screen format="linespecific">IFIELD CADENCE,"","%d"
</screen>
-</section>
-
-<section id="style_def_power">
-<title>POWER</title>
-<para>
- Cycling power in Watts. Only valid for units with power meter
+ </section>
+ <section id="style_def_power">
+ <title>POWER</title>
+ <para>Cycling power in Watts. Only valid for units with power meter
features (i.e. Garmin Edge 305).
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD POWER,"","%.1f"
+ <screen format="linespecific">IFIELD POWER,"","%.1f"
</screen>
-</section>
-
-<section id="style_def_temperature">
-<title>TEMPERATURE</title>
-<para>
- Temperature in degrees Celsius.
+ </section>
+ <section id="style_def_temperature">
+ <title>TEMPERATURE</title>
+ <para>Temperature in degrees Celsius.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD TEMPERATURE,"","%.1f"
+ <screen format="linespecific">IFIELD TEMPERATURE,"","%.1f"
</screen>
-</section>
-
-<section id="style_def_temperaturef">
-<title>TEMPERATURE_F</title>
-<para>
- Temperature in degrees Fahrenheit.
+ </section>
+ <section id="style_def_temperaturef">
+ <title>TEMPERATURE_F</title>
+ <para>Temperature in degrees Fahrenheit.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD TEMPERATURE_F,"","%.1f"
+ <screen format="linespecific">IFIELD TEMPERATURE_F,"","%.1f"
</screen>
-</section>
-
-<section id="style_def_exceltime">
-<title>EXCEL_TIME</title>
-<para>
- EXCEL_TIME is the waypoint's creation time, if any. This is actually
+ </section>
+ <section id="style_def_exceltime">
+ <title>EXCEL_TIME</title>
+ <para>EXCEL_TIME is the waypoint's creation time, if any. This is actually
the decimal days since 1/1/1900 and is handled internally as a DOUBLE
PRECISION FLOAT and requires a FLOATING POINT printf conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD EXCEL_TIME,"","%11.5f"
+ <screen format="linespecific">IFIELD EXCEL_TIME,"","%11.5f"
</screen>
-</section>
-
-<section id="style_def_timettime">
-<title>TIMET_TIME</title>
-<para>
- TIMET_TIME is the waypoint's creation time, if any. This is actually
+ </section>
+ <section id="style_def_timettime">
+ <title>TIMET_TIME</title>
+ <para>TIMET_TIME is the waypoint's creation time, if any. This is actually
the integer seconds since 1/1/1970 (let's not start the holy war) and
is handled internally as a LONG INTEGER and requires a LONG INTEGER
printf conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD TIMET_TIME,"","%ld"
+ <screen format="linespecific">IFIELD TIMET_TIME,"","%ld"
</screen>
-</section>
-
-<section id="style_def_timettimems">
-<title>TIMET_TIME_MS</title>
-<para>
- TIMET_TIME_MS is the same as TIMET_TIME, but expressed in milliseconds.
+ </section>
+ <section id="style_def_timettimems">
+ <title>TIMET_TIME_MS</title>
+ <para>TIMET_TIME_MS is the same as TIMET_TIME, but expressed in milliseconds.
It too is handled internally as a LONG INTEGER and requires a LONG INTEGER
printf conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD TIMET_TIME_MS,"","%ld"
+ <screen format="linespecific">IFIELD TIMET_TIME_MS,"","%ld"
</screen>
-</section>
-
-<section id="style_def_yyyymmdd">
-<title>YYYYMMDD_TIME</title>
-<para>
- YYYYMMDD_TIME is the waypoint's creation time, if any. It's a single
- decimal field containing four digits of year, two digits of month,
+ </section>
+ <section id="style_def_yyyymmdd">
+ <title>YYYYMMDD_TIME</title>
+ <para>YYYYMMDD_TIME is the waypoint's creation time, if any. It's a single
+ decimal field containing four digits of year, two digits of month,
and two digits of date. Internally it is a LONG INTEGER and thus
requires a LONG INTEGER printf conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD YYYYMMDD_TIME,"","%ld"
+ <screen format="linespecific">IFIELD YYYYMMDD_TIME,"","%ld"
</screen>
-</section>
-
-<section id="style_def_gmttime">
-<title>GMT_TIME</title>
-<para>
- GMT_TIME is the waypoint's creation time, in UTC time zone. It uses the
- strptime conversion format tags.
+ </section>
+ <section id="style_def_gmttime">
+ <title>GMT_TIME</title>
+ <para>GMT_TIME is the waypoint's creation time, in UTC time zone. It uses the
+ strptime conversion format tags.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD GMT_TIME,"","%m/%d/%Y %I:%M:%D %p"
+ <screen format="linespecific">IFIELD GMT_TIME,"","%m/%d/%Y %I:%M:%D %p"
</screen>
-<para>
- Search the web for 'strptime man page' for details strptime, but one
+ <para>Search the web for 'strptime man page' for details strptime, but one
such page can be found at
-<ulink url="http://www.die.net/doc/linux/man/man3/strptime.3.html">http://www.die.net/doc/linux/man/man3/strptime.3.html</ulink>
-</para>
-</section>
-<section id="style_def_localtime">
-<title>LOCAL_TIME</title>
-<para>
- LOCAL_TIME is the waypoint's creation time, in the local
+
+
+
+
+
+
+ <ulink url="http://www.die.net/doc/linux/man/man3/strptime.3.html">http://www.die.net/doc/linux/man/man3/strptime.3.html</ulink></para>
+ </section>
+ <section id="style_def_localtime">
+ <title>LOCAL_TIME</title>
+ <para>LOCAL_TIME is the waypoint's creation time, in the local
time zone. It uses strptime conversion format tags. See GMT_TIME for a
reference.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD LOCAL_TIME,"","%y-%m-%d"
+ <screen format="linespecific">IFIELD LOCAL_TIME,"","%y-%m-%d"
</screen>
-</section>
-
-<section id="style_def_hmsgtime">
-<title>HMSG_TIME</title>
-<para>
- HMSG_TIME parses up to three time parts and am/pm string to add
- this value to the previously parsed *_TIME field that contains
+ </section>
+ <section id="style_def_hmsgtime">
+ <title>HMSG_TIME</title>
+ <para>HMSG_TIME parses up to three time parts and am/pm string to add
+ this value to the previously parsed *_TIME field that contains
only a date. On output, will print the time in UTC.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD HMSG_TIME,"","%d:%d:%d %s"
+ <screen format="linespecific">IFIELD HMSG_TIME,"","%d:%d:%d %s"
</screen>
-</section>
-
-<section id="style_def_hmsltime">
-<title>HMSL_TIME</title>
-<para>
- HMSG_TIME parses up to three time parts and am/pm string to add
- this value to the previously parsed *_TIME field that contains
+ </section>
+ <section id="style_def_hmsltime">
+ <title>HMSL_TIME</title>
+ <para>HMSG_TIME parses up to three time parts and am/pm string to add
+ this value to the previously parsed *_TIME field that contains
only a date. On output, will print the time in local time.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD HMSL_TIME,"","%dh%dm"
+ <screen format="linespecific">IFIELD HMSL_TIME,"","%dh%dm"
</screen>
-</section>
-
-<section id="style_def_isotime">
-<title>ISO_TIME</title>
-<para>
- ISO_TIME is the waypoint's creation time, in ISO 8601 format,
- which include time zone information.
+ </section>
+ <section id="style_def_isotime">
+ <title>ISO_TIME</title>
+ <para>ISO_TIME is the waypoint's creation time, in ISO 8601 format,
+ which include time zone information.
It is expected to be in the format yyyy-mm-ddThh:mm:sszzzzz
where zzzzzz is the local time offset or the character Z
for UTC time.
On output, UTC 'Z' time zone will always be used.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD ISO_TIME,"","%s"
+ <screen format="linespecific">IFIELD ISO_TIME,"","%s"
</screen>
-</section>
-
-<section id="style_def_isotimems">
-<title>ISO_TIME_MS</title>
-<para>
- ISO_TIME_MS is much like ISO_TIME, but expresses milliseconds at the
+ </section>
+ <section id="style_def_isotimems">
+ <title>ISO_TIME_MS</title>
+ <para>ISO_TIME_MS is much like ISO_TIME, but expresses milliseconds at the
end of the timestamp.
It is thus in the format yyyy-mm-ddThh:mm:ss.SSSzzzzz
- where 'SSS' is milliseconds and zzzzzz is the local time offset
+ where 'SSS' is milliseconds and zzzzzz is the local time offset
or the character Z for UTC time.
On output, UTC 'Z' time zone will always be used.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD ISO_TIME_MS,"","%s"
+ <screen format="linespecific">IFIELD ISO_TIME_MS,"","%s"
</screen>
-</section>
-
-<section id="style_def_nettime">
-<title>NET_TIME</title>
-<para>
- Microsoft dot net represents times in 100 nanosecond intervals since midnight
- Jan 1/0001 GMT, giving absurdly large numbers like 633943150010000000 for
+ </section>
+ <section id="style_def_nettime">
+ <title>NET_TIME</title>
+ <para>Microsoft dot net represents times in 100 nanosecond intervals since midnight
+ Jan 1/0001 GMT, giving absurdly large numbers like 633943150010000000 for
mid-November, 2009. NET_TIME is how to represent those in GPSBabel.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD NET_TIME,"","%f"
+ <screen format="linespecific">IFIELD NET_TIME,"","%f"
</screen>
-</section>
-
-<section id="style_def_geodiff">
-<title>GEOCACHE_DIFF</title>
-<para>
- GEOCACHE_DIFF is valid only for geocaches and represents a DOUBLE
- PRECISION FLOAT. This is the geocache "difficulty" rating as defined by
- Groundspeak. A "three and a half star" cache would therefore be "3.5"
+ </section>
+ <section id="style_def_geodiff">
+ <title>GEOCACHE_DIFF</title>
+ <para>GEOCACHE_DIFF is valid only for geocaches and represents a DOUBLE
+ PRECISION FLOAT. This is the geocache "difficulty" rating as defined by
+ Groundspeak. A "three and a half star" cache would therefore be "3.5"
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD GEOCACHE_DIFF,"","%3.1f"
+ <screen format="linespecific">IFIELD GEOCACHE_DIFF,"","%3.1f"
</screen>
-</section>
-
-<section id="style_def_geoterr">
-<title>GEOCACHE_TERR</title>
-<para>
- GEOCACHE_TERR is valid only for geocaches and represents a DOUBLE
- PRECISION FLOAT. This is the geocache "terrain" rating as defined
- by Groundspeak. A "three and a half star" cache would therefore be "3.5"
+ </section>
+ <section id="style_def_geoterr">
+ <title>GEOCACHE_TERR</title>
+ <para>GEOCACHE_TERR is valid only for geocaches and represents a DOUBLE
+ PRECISION FLOAT. This is the geocache "terrain" rating as defined
+ by Groundspeak. A "three and a half star" cache would therefore be "3.5"
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> IFIELD GEOCACHE_TERR,"","%3.1f"
+ <screen format="linespecific">IFIELD GEOCACHE_TERR,"","%3.1f"
</screen>
-</section>
-
-<section id="style_def_geocontainer">
-<title>GEOCACHE_CONTAINER</title>
-<para>
- GEOCACHE_CONTAINER is valid only for geocaches and is heavily influenced
- by the Groundspeak container types. Examples would include "Micro"
- and "Virtual".
+ </section>
+ <section id="style_def_geocontainer">
+ <title>GEOCACHE_CONTAINER</title>
+ <para>GEOCACHE_CONTAINER is valid only for geocaches and is heavily influenced
+ by the Groundspeak container types. Examples would include "Micro"
+ and "Virtual".
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_CONTAINER,"","%s"
+ <screen format="linespecific">GEOCACHE_CONTAINER,"","%s"
</screen>
-</section>
-
-<section id="style_def_geotype">
-<title>GEOCACHE_TYPE</title>
-<para>
- GEOCACHE_TYPE is valid only for geocaches and is heavily influenced
- by the Groundspeak cache types. Examples would include "Event cache"
- and "Multi-Cache".
+ </section>
+ <section id="style_def_geotype">
+ <title>GEOCACHE_TYPE</title>
+ <para>GEOCACHE_TYPE is valid only for geocaches and is heavily influenced
+ by the Groundspeak cache types. Examples would include "Event cache"
+ and "Multi-Cache".
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_TYPE,"","%s"
+ <screen format="linespecific">GEOCACHE_TYPE,"","%s"
</screen>
-</section>
-
-<section id="style_def_geoplacer">
-<title>GEOCACHE_PLACER</title>
-<para>
- GEOCACHE_PLACER is a string containing the name of the placer of a
- geocache.
+ </section>
+ <section id="style_def_geoplacer">
+ <title>GEOCACHE_PLACER</title>
+ <para>GEOCACHE_PLACER is a string containing the name of the placer of a
+ geocache.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_PLACER,"","%s"
+ <screen format="linespecific">GEOCACHE_PLACER,"","%s"
</screen>
-</section>
-
-<section id="style_def_isavailable">
-<title>GEOCACHE_ISAVAILABLE</title>
-<para>
- GEOCACHE_ISAVAILABLE is a string containing "True" or "False"
- indicating whether a geocache is currently available or not.
+ </section>
+ <section id="style_def_isavailable">
+ <title>GEOCACHE_ISAVAILABLE</title>
+ <para>GEOCACHE_ISAVAILABLE is a string containing "True" or "False"
+ indicating whether a geocache is currently available or not.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_ISAVAILABLE,"","%s"
+ <screen format="linespecific">GEOCACHE_ISAVAILABLE,"","%s"
</screen>
-</section>
-
-<section id="style_def_isarchived">
-<title>GEOCACHE_ISARCHIVED</title>
-<para>
- GEOCACHE_ISARCHIVED is a string containing "True" or "False"
- indicating whether a geocache has been archived.
+ </section>
+ <section id="style_def_isarchived">
+ <title>GEOCACHE_ISARCHIVED</title>
+ <para>GEOCACHE_ISARCHIVED is a string containing "True" or "False"
+ indicating whether a geocache has been archived.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_ISARCHIVED,"","%s"
+ <screen format="linespecific">GEOCACHE_ISARCHIVED,"","%s"
</screen>
-</section>
-
-<section id="style_def_geofound">
-<title>GEOCACHE_LAST_FOUND</title>
-<para>
- A long integer in format YYYYMMDD containing the last time this geocache
+ </section>
+ <section id="style_def_geofound">
+ <title>GEOCACHE_LAST_FOUND</title>
+ <para>A long integer in format YYYYMMDD containing the last time this geocache
was found.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_LAST_FOUND,"","%ld"
+ <screen format="linespecific">GEOCACHE_LAST_FOUND,"","%ld"
</screen>
-</section>
-
-<section id="style_def_geohint">
-<title>GEOCACHE_HINT</title>
-<para>
- The hint for this geocache. No additional transformation (such as rot13)
+ </section>
+ <section id="style_def_geohint">
+ <title>GEOCACHE_HINT</title>
+ <para>The hint for this geocache. No additional transformation (such as rot13)
will be performed on this string.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GEOCACHE_HINT,"","%s"
+ <screen format="linespecific">GEOCACHE_HINT,"","%s"
</screen>
-</section>
-
-<section id="style_def_pathdistmi">
-<title>PATH_DISTANCE_MILES</title>
-<para>
- PATH_DISTANCE_MILES outputs the total length of the route or track from
+ </section>
+ <section id="style_def_pathdistmi">
+ <title>PATH_DISTANCE_MILES</title>
+ <para>PATH_DISTANCE_MILES outputs the total length of the route or track from
the start point to the current point, in miles. This and the altitude
could be used to create an elevation profile. PATH_DISTANCE_MILES is
a DOUBLE PRECISION FLOAT.
</para>
-<para>
- PATH_DISTANCE_MILES is not valid as an input field.
+ <para>PATH_DISTANCE_MILES is not valid as an input field.
</para>
-<para>
- PATH_DISTANCE_MILES is only meaningful if the data comes from a track
+ <para>PATH_DISTANCE_MILES is only meaningful if the data comes from a track
or a route; waypoint data will generate essentially meaningless output.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> PATH_DISTANCE_MILES,"","%f"
+ <screen format="linespecific">PATH_DISTANCE_MILES,"","%f"
</screen>
-</section>
-
-<section id="style_def_pathdistkm">
-<title>PATH_DISTANCE_KM</title>
-<para>
- PATH_DISTANCE_KM is like PATH_DISTANCE_MILES except it outputs the
- length in kilometers.
+ </section>
+ <section id="style_def_pathdistkm">
+ <title>PATH_DISTANCE_KM</title>
+ <para>PATH_DISTANCE_KM is like PATH_DISTANCE_MILES except it outputs the
+ length in kilometers.
</para>
-</section>
-
-<section id="style_def_pathdistm">
-<title>PATH_DISTANCE_METERS</title>
-<para>
- PATH_DISTANCE_METERS is like PATH_DISTANCE_MILES except it outputs the
- length in meters.
+ </section>
+ <section id="style_def_pathdistm">
+ <title>PATH_DISTANCE_METERS</title>
+ <para>PATH_DISTANCE_METERS is like PATH_DISTANCE_MILES except it outputs the
+ length in meters.
</para>
-</section>
-
-<section id="style_def_pathspeed">
-<title>PATH_SPEED</title>
-<para>
- Speed in meters per second. GPSBabel does NOT calculate this data by
+ </section>
+ <section id="style_def_pathspeed">
+ <title>PATH_SPEED</title>
+ <para>Speed in meters per second. GPSBabel does NOT calculate this data by
default; it is read from the input file if present. (If not present,
- it may be calculated with the <link linkend="filter_track">track</link>
- filter.)
-</para>
-<para>
-example:
+ it may be calculated with the
+
+
+
+
+
+
+ <link linkend="filter_track">track</link>
+ filter.)</para>
+ <para>example:
</para>
-<screen format="linespecific"> PATH_SPEED,"","%f"
+ <screen format="linespecific">PATH_SPEED,"","%f"
</screen>
-</section>
-
-<section id="style_def_pathspeed_kph">
-<title>PATH_SPEED_KPH</title>
-<para>
- Like PATH_SPEED but means kilometers per hour.
+ </section>
+ <section id="style_def_pathspeed_kph">
+ <title>PATH_SPEED_KPH</title>
+ <para>Like PATH_SPEED but means kilometers per hour.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> PATH_SPEED_KPH,"","%.1f"
+ <screen format="linespecific">PATH_SPEED_KPH,"","%.1f"
</screen>
-</section>
-
-<section id="style_def_pathspeed_mph">
-<title>PATH_SPEED_MPH</title>
-<para>
- Like PATH_SPEED but means miles per hour.
+ </section>
+ <section id="style_def_pathspeed_mph">
+ <title>PATH_SPEED_MPH</title>
+ <para>Like PATH_SPEED but means miles per hour.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> PATH_SPEED_MPH,"","%.1f"
+ <screen format="linespecific">PATH_SPEED_MPH,"","%.1f"
</screen>
-</section>
-
-<section id="style_def_pathspeed_knots">
-<title>PATH_SPEED_KNOTS</title>
-<para>
- Like PATH_SPEED but means knots (nautical).
+ </section>
+ <section id="style_def_pathspeed_knots">
+ <title>PATH_SPEED_KNOTS</title>
+ <para>Like PATH_SPEED but means knots (nautical).
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> PATH_SPEED_KNOTS,"","%.1f"
+ <screen format="linespecific">PATH_SPEED_KNOTS,"","%.1f"
</screen>
-</section>
-
-<section id="style_def_pathcourse">
-<title>PATH_COURSE</title>
-<para>
- Course in degrees. GPSBabel does not calculate this data by default;
+ </section>
+ <section id="style_def_pathcourse">
+ <title>PATH_COURSE</title>
+ <para>Course in degrees. GPSBabel does not calculate this data by default;
it is read from the input file if present. (If not present, it may be
- calculated with the <link linkend="filter_track">track</link> filter.)
-</para>
-<para>
-example:
+ calculated with the
+
+
+
+
+
+
+ <link linkend="filter_track">track</link>
+ filter.)</para>
+ <para>example:
</para>
-<screen format="linespecific"> PATH_COURSE,"","%f"
+ <screen format="linespecific">PATH_COURSE,"","%f"
</screen>
-</section>
-
-<section id="style_def_dop">
-<title>GPS_HDOP / GPS_VDOP / GPS_PDOP</title>
-<para>
- GPS horizontal / vertical / positional dilution of precision
+ </section>
+ <section id="style_def_dop">
+ <title>GPS_HDOP / GPS_VDOP / GPS_PDOP</title>
+ <para>GPS horizontal / vertical / positional dilution of precision
parameters. Needs float conversion.
</para>
-<para>
-example:
+ <para>example:
</para>
-<screen format="linespecific"> GPS_HDOP,"","%f"
+ <screen format="linespecific">GPS_HDOP,"","%f"
</screen>
-</section>
-
-<section id="style_def_gpssat">
-<title>GPS_SAT</title>
-<para>
- Number of satellites used for determination of the position. Needs
+ </section>
+ <section id="style_def_gpssat">
+ <title>GPS_SAT</title>
+ <para>Number of satellites used for determination of the position. Needs
integer conversion.
</para>
-<para>
-example:
-</para>
-<screen format="linespecific"> GPS_SAT,"","%d"
-</screen>
-</section>
-
-<section id="style_def_gpsfix">
-<title>GPS_FIX</title>
-<para>
- Type of fix (see GPX spec or <link linkend="filter_track">track</link>
-filter). Needs string conversion.
-</para>
-<para>
-example:
-</para>
-<screen format="linespecific"> GPS_FIX,"","%s"
-</screen>
-</section>
-
-<section id="style_track_new">
-<title>TRACK_NEW</title>
-<para>If '1', it indicates that this trackpoint is the first point of a new track. Needs integer conversion.</para><para>example:<screen format="linespecific">IFIELD TRACK_NEW,"","%d"</screen></para></section>
-
-
-<section id="style_track_name">
-<title>TRACK_NAME</title>
-<para>The name of the track currently being operated on. Needs string conversion.</para><para>example:<screen format="linespecific">TRACK_NAME, "", "%s"</screen></para></section>
-
-<section id="style_route_name">
-<title>ROUTE_NAME</title>
-<para>The name of the route currently being operated on. Needs string conversion.</para><para>example:<screen format="linespecific">ROUTE_NAME, "", "%s"</screen></para></section>
-
-<section id="style_street_addr">
-<title>STREET_ADDR</title>
-<para>Street address including house number. Notice that this is not used for any geocoding, it's merely textual description associated with a position.</para>
-<para>example:<screen format="linespecific">STREET_ADDR, "", "%s"</screen></para>
-</section>
-
-<section id="style_city">
-<title>CITY</title>
-<para>The name of a city. Sometimes part of "Points of Interest". This is simple textual data associated with a position, no geocoding will be done..</para>
-<para>example:<screen format="linespecific">CITY, "", "%s"</screen></para>
-</section>
-
-<section id="style_country">
-<title>COUNTRY</title>
-<para>The name of a country associated with a position.</para>
-<para>example:<screen format="linespecific">COUNTRY, "", "%s"</screen></para>
-</section>
-
-<section id="style_facility">
-<title>FACILITY</title>
-<para>The name of a facility to associate with a position.</para>
-<para>example:<screen format="linespecific">FACILITY, "", "%s"</screen></para>
-</section>
-
-<section id="style_phone_nr">
-<title>PHONE_NR</title>
-<para>A phone number associated with a position. This is just textual data attached for convenience.</para>
-<para>example:<screen format="linespecific">PHONE_NR, "", "%s"</screen></para>
-</section>
-
-<section id="style_postal_code">
-<title>POSTAL_CODE</title>
-<para>A postal code to associate with a position. It is freeform text and is not used by GPSBabel for any geocoding or such.</para>
-<para>example:<screen format="linespecific">POSTAL_CODE, "", "%s"</screen></para>
-</section>
-
-<section id="style_filename">
-<title>FILENAME</title>
-<para>The name of the input file from where the points were loaded. This field is available only on output.</para>
-<para>example:<screen format="linespecific">OFIELD FILENAME, "", "%s"</screen></para>
-</section>
-
-<section id="style_format">
-<title>FORMAT</title>
-<para>The name of the input format from where format the points came. This field is available only on output.</para>
-<para>example:<screen format="linespecific">OFIELD FORMAT, "", "%s"</screen></para>
-</section>
-
-</section> <!-- definitions -->
-
-<section id="style_examples">
-<title>Examples</title>
-<para>
-Here is one example style file from the GPSBabel source.
-<literallayout>
-# gpsbabel XCSV style file
+ <para>example:
+</para>
+ <screen format="linespecific">GPS_SAT,"","%d"
+</screen>
+ </section>
+ <section id="style_def_gpsfix">
+ <title>GPS_FIX</title>
+ <para>Type of fix (see GPX spec or
+
+
+
+
+
+
+ <link linkend="filter_track">track</link>
+ filter). Needs string conversion.</para>
+ <para>example:
+</para>
+ <screen format="linespecific">GPS_FIX,"","%s"
+</screen>
+ </section>
+ <section id="style_track_new">
+ <title>TRACK_NEW</title>
+ <para>If '1', it indicates that this trackpoint is the first point of a new track. Needs integer conversion.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">IFIELD TRACK_NEW,"","%d"</screen></para>
+ </section>
+ <section id="style_track_name">
+ <title>TRACK_NAME</title>
+ <para>The name of the track currently being operated on. Needs string conversion.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">TRACK_NAME, "", "%s"</screen></para>
+ </section>
+ <section id="style_route_name">
+ <title>ROUTE_NAME</title>
+ <para>The name of the route currently being operated on. Needs string conversion.</para>
+ <para>example:
+ <screen format="linespecific">ROUTE_NAME, "", "%s"</screen></para>
+ </section>
+ <section id="style_street_addr">
+ <title>STREET_ADDR</title>
+ <para>Street address including house number. Notice that this is not used for any geocoding, it's merely textual description associated with a position.</para>
+ <para>example:
+
+ <screen format="linespecific">STREET_ADDR, "", "%s"</screen></para>
+ </section>
+ <section id="style_city">
+ <title>CITY</title>
+ <para>The name of a city. Sometimes part of "Points of Interest". This is simple textual data associated with a position, no geocoding will be done..</para>
+ <para>example:
+ <screen format="linespecific">CITY, "", "%s"</screen></para>
+ </section>
+ <section id="style_country">
+ <title>COUNTRY</title>
+ <para>The name of a country associated with a position.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">COUNTRY, "", "%s"</screen></para>
+ </section>
+ <section id="style_facility">
+ <title>FACILITY</title>
+ <para>The name of a facility to associate with a position.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">FACILITY, "", "%s"</screen></para>
+ </section>
+ <section id="style_phone_nr">
+ <title>PHONE_NR</title>
+ <para>A phone number associated with a position. This is just textual data attached for convenience.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">PHONE_NR, "", "%s"</screen></para>
+ </section>
+ <section id="style_postal_code">
+ <title>POSTAL_CODE</title>
+ <para>A postal code to associate with a position. It is freeform text and is not used by GPSBabel for any geocoding or such.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">POSTAL_CODE, "", "%s"</screen></para>
+ </section>
+ <section id="style_filename">
+ <title>FILENAME</title>
+ <para>The name of the input file from where the points were loaded. This field is available only on output.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">OFIELD FILENAME, "", "%s"</screen></para>
+ </section>
+ <section id="style_format">
+ <title>FORMAT</title>
+ <para>The name of the input format from where format the points came. This field is available only on output.</para>
+ <para>example:
+
+
+
+
+
+
+ <screen format="linespecific">OFIELD FORMAT, "", "%s"</screen></para>
+ </section>
+ </section>
+ <!-- definitions -->
+ <section id="style_examples">
+ <title>Examples</title>
+ <para>Here is one example style file from the GPSBabel source.
+
+
+
+
+
+
+
+ <literallayout># gpsbabel XCSV style file
#
# Format: Garmin POI
# Author: Robert Lipe
#
# INDIVIDUAL DATA FIELDS, IN ORDER OF APPEARANCE:
#
-IFIELD LON_HUMAN_READABLE, "", "%08.5f"
-IFIELD LAT_HUMAN_READABLE, "", "%08.5f"
-IFIELD SHORTNAME, "", "%s"
-IFIELD DESCRIPTION, "", "%s"
-
-OFIELD LON_DECIMAL, "", "%08.5f"
-OFIELD LAT_DECIMAL, "", "%08.5f"
-OFIELD SHORTNAME, "", "%-.24s"
-OFIELD GEOCACHE_TYPE, "", " %-.4s", "no_delim_before,optional"
-OFIELD GEOCACHE_CONTAINER, "", "/%-.4s ", "no_delim_before,optional"
-OFIELD GEOCACHE_DIFF, "", "(%3.1f", "no_delim_before,optional"
-OFIELD GEOCACHE_TERR, "", "/%3.1f)", "no_delim_before,optional"
-OFIELD DESCRIPTION, "", "%-.50s"
+IFIELD LON_HUMAN_READABLE, "", "%08.5f"
+IFIELD LAT_HUMAN_READABLE, "", "%08.5f"
+IFIELD SHORTNAME, "", "%s"
+IFIELD DESCRIPTION, "", "%s"
+
+OFIELD LON_DECIMAL, "", "%08.5f"
+OFIELD LAT_DECIMAL, "", "%08.5f"
+OFIELD SHORTNAME, "", "%-.24s"
+OFIELD GEOCACHE_TYPE, "", " %-.4s", "no_delim_before,optional"
+OFIELD GEOCACHE_CONTAINER, "", "/%-.4s ", "no_delim_before,optional"
+OFIELD GEOCACHE_DIFF, "", "(%3.1f", "no_delim_before,optional"
+OFIELD GEOCACHE_TERR, "", "/%3.1f)", "no_delim_before,optional"
+OFIELD DESCRIPTION, "", "%-.50s"
</literallayout>
-When used on a Groundspeak Pocket Query, it will output lines that
+ When used on a Groundspeak Pocket Query, it will output lines that
look like:
-<literallayout>
--76.76234,38.39123,GC5370 Loca/Virt (1.0/1.0),Dude.. Wheres my Limo??
+
+
+ <literallayout>-76.76234,38.39123,GC5370 Loca/Virt (1.0/1.0),Dude.. Wheres my Limo??
-90.42345,38.55234,GCC8B Trad/Regu (2.0/2.0),Sweet Reward
-90.81456,38.62456,GC3091 Trad/Regu (1.5/2.0),Matson Hill
</literallayout>
-that are suitable for Garmin's POI loader.
-</para>
-<para>
-For additional examples, please see the
-<filename>*.style</filename> files in the
-<filename>style/</filename> subdirectory of the GPSBabel source tree or at the <ulink url="https://github.com/gpsbabel/gpsbabel/tree/master/style">online source.</ulink>.
-</para>
-</section> <!-- examples -->
+ that are suitable for Garmin's POI loader.</para>
+ <para>For additional examples, please see the
-<section id="style_notes">
-<title>Miscellaneous Notes</title>
-<section id="style_notes_default">
-<title>Default Values</title>
-<para>
-Default values are supported for any output fields that contain pure
+
+ <filename>*.style</filename>
+ files in the
+
+
+ <filename>style/</filename>
+ subdirectory of the GPSBabel source tree or at the
+
+
+ <ulink url="https://github.com/gpsbabel/gpsbabel/tree/master/style">online source.</ulink>
+ .</para>
+ </section>
+ <!-- examples -->
+ <section id="style_notes">
+ <title>Miscellaneous Notes</title>
+ <section id="style_notes_default">
+ <title>Default Values</title>
+ <para>Default values are supported for any output fields that contain pure
character data output such as URL and NOTES. Default values are only
- written on output and are not used to supplement missing input. When
- using default values your mileage will vary greatly depending on the
+ written on output and are not used to supplement missing input. When
+ using default values your mileage will vary greatly depending on the
input formats used to populate waypoint data.
</para>
-</section>
-</section><!-- notes -->
-
-</appendix><!-- style -->
+ </section>
+ </section>
+ <!-- notes -->
+</appendix>
+<!-- style -->
\ No newline at end of file
- <chapter id="Usage">
- <title>Usage</title>
- <sect1 id="Invocation">
- <title>Invocation</title>
-<para>
-If you're using GPSBabel, you will need to know how to do at least two things:
+<chapter id="Usage">
+ <title>Usage</title>
+ <sect1 id="Invocation">
+ <title>Invocation</title>
+ <para>If you're using GPSBabel, you will need to know how to do at least two things:
read data from a file, and write it to another file. There are four basic
options you need to know to do those things:
</para>
-<segmentedlist>
-<?dbhtml list-presentation="table"?>
-<segtitle>Command</segtitle>
-<segtitle>Meaning</segtitle>
-<seglistitem>
- <seg><option>-i</option> <parameter class="command">format</parameter></seg>
- <seg>Set input format</seg>
-</seglistitem>
-<seglistitem>
- <seg><option>-f</option> <parameter class="command">filename</parameter></seg>
- <seg>Read file</seg>
-</seglistitem>
-<seglistitem>
- <seg><option>-o</option> <parameter class="command">format</parameter></seg>
- <seg>Set output format</seg>
-</seglistitem>
-<seglistitem>
- <seg><option>-F</option> <parameter class="command">filename</parameter></seg>
- <seg>Write output file</seg>
-</seglistitem>
-</segmentedlist>
-<important>
-<para>
-Case matters. Notably <option>-f</option> (lowercase) sets the <emphasis>input</emphasis> file. <option> -F</option> (uppercase) sets the <emphasis>output</emphasis> file.
-</para>
-</important>
-
-<para>
-The <parameter class="command">format</parameter> parameters in the above list
-refer to the names of formats or file types supported by GPSBabel.
-</para>
-<para><userinput>gpsbabel -? </userinput></para>
-<para>will always show you the supported file types. In this document, the
-various supported formats are listed in <xref linkend="The_Formats" />. The
-name that you would use on the command line follows the format name in
-parentheses.
-</para>
-<para>
-Options are <emphasis>always</emphasis> processed in order from left to right.
+ <segmentedlist>
+ <?dbhtml list-presentation="table"?>
+ <segtitle>Command</segtitle>
+ <segtitle>Meaning</segtitle>
+ <seglistitem>
+ <seg>
+ <option>-i</option>
+ <parameter class="command">format</parameter>
+ </seg>
+ <seg>Set input format</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>
+ <option>-f</option>
+ <parameter class="command">filename</parameter>
+ </seg>
+ <seg>Read file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>
+ <option>-o</option>
+ <parameter class="command">format</parameter>
+ </seg>
+ <seg>Set output format</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>
+ <option>-F</option>
+ <parameter class="command">filename</parameter>
+ </seg>
+ <seg>Write output file</seg>
+ </seglistitem>
+ </segmentedlist>
+ <important>
+ <para>Case matters. Notably
+ <option>-f</option>
+ (lowercase) sets the
+ <emphasis>input</emphasis>
+ file.
+ <option>-F</option>
+ (uppercase) sets the
+ <emphasis>output</emphasis>
+ file. </para>
+ </important>
+ <para>The
+ <parameter class="command">format</parameter>
+ parameters in the above list
+refer to the names of formats or file types supported by GPSBabel. </para>
+ <para>
+ <userinput>gpsbabel -? </userinput>
+ </para>
+ <para>will always show you the supported file types. In this document, the
+various supported formats are listed in
+ <xref linkend="The_Formats"/>
+ . The
+name that you would use on the command line follows the format name in
+parentheses.</para>
+ <para>Options are
+ <emphasis>always</emphasis>
+ processed in order from left to right.
In practical terms, this means that things you want to read should appear
in the command before things you want to write. This sometimes surprises
-new users as adding options to turn on debugging at the end, for example,
+new users as adding options to turn on debugging at the end, for example,
doesn't work as the debugging is turned on after all the interesting work is
done. The reason for this strict ordering becomes more apparent once you
-learn about mixing formats and filters.
-</para>
-<para>
-The <parameter class="command">filename</parameter> parameters specify the
-name of a file to be read or written.
-</para>
-
-<para>To use
+learn about mixing formats and filters.</para>
+ <para>The
+ <parameter class="command">filename</parameter>
+ parameters specify the
+name of a file to be read or written.</para>
+ <para>To use
GPSBabel in its simplest form, just tell it what you're reading, where to read
it from, what you're writing, and what to write it to. For
example:</para>
- <para><userinput>gpsbabel -i geo -f /tmp/geocaching.loc -o gpx -F /tmp/geocaching.gpx</userinput></para>
- <para>tells it to read the file <filename>/tmp/geocaching.loc</filename> in geocaching.com
- format and create a new file <filename>/tmp/geocaching.gpx</filename> in GPX format. It's important to note that the names have nothing to do with the formats actually used.</para>
- <para> This command will read from a Magellan unit attached
+ <para>
+ <userinput>gpsbabel -i geo -f /tmp/geocaching.loc -o gpx -F /tmp/geocaching.gpx</userinput>
+ </para>
+ <para>tells it to read the file
+ <filename>/tmp/geocaching.loc</filename>
+ in geocaching.com
+ format and create a new file
+ <filename>/tmp/geocaching.gpx</filename>
+ in GPX format. It's important to note that the names have nothing to do with the formats actually used.</para>
+ <para>This command will read from a Magellan unit attached
to the first serial port on a Linux system (device names will
vary on other OSes; typically COMx: on Windows) and write them as a geocaching loc file.</para>
-<example id="linux_download_from_magellan">
- <title>Command showing Linux download from Magellan serial and writing to .loc file</title>
- <para><userinput>gpsbabel -i magellan -f /dev/ttyS0 -o geo -F mag.loc</userinput></para>
-</example>
- <para>This second command does the same on Microsoft Windows.</para>
-<example id="windows_download_from_magellan">
- <title>Command showing Windows download from Magellan serial and writing to .loc file</title>
- <para><userinput>gpsbabel -i magellan -f com1 -o geo -F mag.loc</userinput></para>
-</example>
- <para>Optionally, you may specify <parameter moreinfo="none">-s</parameter> in any command line. This
- causes the program to ignore any "short" names that may be
+ <example id="linux_download_from_magellan">
+ <title>Command showing Linux download from Magellan serial and writing to .loc file</title>
+ <para>
+ <userinput>gpsbabel -i magellan -f /dev/ttyS0 -o geo -F mag.loc</userinput>
+ </para>
+ </example>
+ <para>This second command does the same on Microsoft Windows.</para>
+ <example id="windows_download_from_magellan">
+ <title>Command showing Windows download from Magellan serial and writing to .loc file</title>
+ <para>
+ <userinput>gpsbabel -i magellan -f com1 -o geo -F mag.loc</userinput>
+ </para>
+ </example>
+ <para>Optionally, you may specify
+ <parameter moreinfo="none">-s</parameter>
+ in any command line. This
+ causes the program to ignore any "short" names that may be
present in the source data format and synthesize one from the
long name. This is particularly useful if you're writing to
a target format that isn't the lowest common denominator but
the source data was written for the lowest common
denominator. This is useful for writing data from geocaching.com
- to a GPS so my waypoints have "real" names instead of
- the 'GC1234' ones that are optimized for receivers of the lowest
- common denominator.
+ to a GPS so my waypoints have "real" names instead of
+ the 'GC1234' ones that are optimized for receivers of the lowest
+ common denominator.
A geocacher using Linux with a Magellan receiver may thus find commands
like this useful.</para>
- <para><userinput>gpsbabel -s -i geo -f geocaching.loc -o magellan -F /dev/ttyS0 </userinput></para>
- <para>His counterpart on Windows will find this equivalent</para>
- <para><userinput>gpsbabel -s -i geo -f geocaching.loc -o magellan -F com1</userinput></para>
- </sect1>
- <sect1 id="Suboptions">
- <title>Suboptions</title>
- <para>
- Many of the available format options in GPSBabel can themselves
- take options. While we try to make all the formats do the most
- sensible thing possible without any extra options; this allows
- great power and flexibility in the operation of the program.
- </para>
- <para>
- Suboptions are comma separated and immediately follow the option
- itself. The available suboptions are listed on the individual
- format pages. We'll make an example from <xref linkend="fmt_kml" />:
- </para>
- <para><userinput>gpsbabel -i gpx -f file.gpx -o kml,deficon="file://myicon.png",lines=0 -F one.kml -o kml -F two.kml</userinput></para>
- <para>
- This command will read the GPX file <filename>file.gpx</filename>
- and create two KML files. <filename>one.kml</filename> will
- have the given icon and no lines between track and routepoints.
- <filename>two.kml</filename> will be created with the defaults used
- in the KML writer.
- </para>
- <para>
- Suboptions for the various formats allow you to change serial speeds,
- pass arguments to filters, change the type of file written, override
- icon defaults, and lots of other things. The suboptions for each
- filetype are documented on the page in this document that describes
- the option itself.
- </para>
- </sect1>
- <sect1 id="Advanced_Usage">
- <title>Advanced Usage</title>
- <para>Argument are processed in the order they appear on the command
+ <para>
+ <userinput>gpsbabel -s -i geo -f geocaching.loc -o magellan -F /dev/ttyS0 </userinput>
+ </para>
+ <para>His counterpart on Windows will find this equivalent</para>
+ <para>
+ <userinput>gpsbabel -s -i geo -f geocaching.loc -o magellan -F com1</userinput>
+ </para>
+ </sect1>
+ <sect1 id="Suboptions">
+ <title>Suboptions</title>
+ <para>Many of the available format options in GPSBabel can themselves
+ take options. While we try to make all the formats do the most
+ sensible thing possible without any extra options; this allows
+ great power and flexibility in the operation of the program.
+ </para>
+ <para>Suboptions are comma separated and immediately follow the option
+ itself. The available suboptions are listed on the individual
+ format pages. We'll make an example from
+ <xref linkend="fmt_kml"/>
+ :</para>
+ <para>
+ <userinput>gpsbabel -i gpx -f file.gpx -o kml,deficon="file://myicon.png",lines=0 -F one.kml -o kml -F two.kml</userinput>
+ </para>
+ <para>This command will read the GPX file
+ <filename>file.gpx</filename>
+ and create two KML files.
+ <filename>one.kml</filename>
+ will
+ have the given icon and no lines between track and routepoints.
+
+ <filename>two.kml</filename>
+ will be created with the defaults used
+ in the KML writer.</para>
+ <para>Suboptions for the various formats allow you to change serial speeds,
+ pass arguments to filters, change the type of file written, override
+ icon defaults, and lots of other things. The suboptions for each
+ filetype are documented on the page in this document that describes
+ the option itself.
+ </para>
+ </sect1>
+ <sect1 id="Advanced_Usage">
+ <title>Advanced Usage</title>
+ <para>Argument are processed in the order they appear on the command
line and are translated internally into a pipeline that data flows
through when executed. Normally one would: </para>
- <simplelist type="vert">
- <member>read from one input</member>
- <member>optionally apply filters </member>
- <member>write into one output</member>
- </simplelist>
- <para> but GPSBabel is flexible enough to allow more complicated
+ <simplelist type="vert">
+ <member>read from one input</member>
+ <member>optionally apply filters </member>
+ <member>write into one output</member>
+ </simplelist>
+ <para>but GPSBabel is flexible enough to allow more complicated
operations such as reading from several files (potentially of
different types), applying a filter, reading more data, then writing the
merged data to multiple destinations.
</para>
- <para>The input file type remains unchanged until a new
- <parameter moreinfo="none">-i</parameter> argument is seen.
+ <para>The input file type remains unchanged until a new
+
+ <parameter moreinfo="none">-i</parameter>
+ argument is seen.
Files are read in the order they appear. So you could merge
three input files into one output file with: </para>
- <example id="merging_files">
- <title>Merging multiple files into one</title>
- <para><userinput>gpsbabel -i geo -f 1.loc -f 2.loc -f 3.loc -o geo -F big.loc</userinput></para>
- </example>
- <para>You can merge files of different types:</para>
- <example id="merging_different_types_of_files">
- <title>Merging multiple files of differing types.</title>
- <para><userinput>gpsbabel -i geo -f 1.loc -i gpx -f 2.gpx -i pcx 3.pcx -o gpsutil -F big.gps</userinput></para>
- </example>
- <example id="multiple_writes">
- <title>Writing the same data in multiple output formats.</title>
- <para> You can write the same data in different output formats:</para>
-
- <para><userinput>gpsbabel -i geo -f 1.loc -o gpx -F 1.gpx -o pcx -F 1.wpt</userinput></para>
- </example>
- </sect1>
- <sect1 id="Route_And_Track_Modes">
- <title>Route and Track Modes</title>
- <para> Most formats supported by GPSBabel will make a reasonable attempt to work
+ <example id="merging_files">
+ <title>Merging multiple files into one</title>
+ <para>
+ <userinput>gpsbabel -i geo -f 1.loc -f 2.loc -f 3.loc -o geo -F big.loc</userinput>
+ </para>
+ </example>
+ <para>You can merge files of different types:</para>
+ <example id="merging_different_types_of_files">
+ <title>Merging multiple files of differing types.</title>
+ <para>
+ <userinput>gpsbabel -i geo -f 1.loc -i gpx -f 2.gpx -i pcx 3.pcx -o gpsutil -F big.gps</userinput>
+ </para>
+ </example>
+ <example id="multiple_writes">
+ <title>Writing the same data in multiple output formats.</title>
+ <para>You can write the same data in different output formats:</para>
+ <para>
+ <userinput>gpsbabel -i geo -f 1.loc -o gpx -F 1.gpx -o pcx -F 1.wpt</userinput>
+ </para>
+ </example>
+ </sect1>
+ <sect1 id="Route_And_Track_Modes">
+ <title>Route and Track Modes</title>
+ <para>Most formats supported by GPSBabel will make a reasonable attempt to work
transparently with waypoints, tracks, and routes. Some
- formats, like <link linkend="fmt_garmin">garmin</link> and <link linkend="fmt_magellan">magellan</link> require the <parameter moreinfo="none">-t</parameter> flag to work with tracks and
- <parameter moreinfo="none">-r</parameter> to work with
- routes. <parameter moreinfo="none">-w</parameter> is for
+ formats, like
+ <link linkend="fmt_garmin">garmin</link>
+ and
+ <link linkend="fmt_magellan">magellan</link>
+ require the
+ <parameter moreinfo="none">-t</parameter>
+ flag to work with tracks and
+
+ <parameter moreinfo="none">-r</parameter>
+ to work with
+ routes.
+ <parameter moreinfo="none">-w</parameter>
+ is for
waypoints, and is the default. So if you wanted to read all
data from a Magellan Meridian GPS receiver into a gpx file, you might use a command
like:</para>
- <para><userinput> gpsbabel -t -r -w -i magellan -f com1: -o gpx -F backup.gpx</userinput></para>
- <para> Tracks and routes are advanced features and don't try
+ <para>
+ <userinput>gpsbabel -t -r -w -i magellan -f com1: -o gpx -F backup.gpx</userinput>
+ </para>
+ <para>Tracks and routes are advanced features and don't try
to handle every possible hazard that can be encountered
during a conversion. If you're merging or converting files
of similar limitations, things work very well.</para>
- <para> Many of those hazards can be overcome with our filters
- but there are often compromises to be made. For example, if you
- have a GPX route that contains 150 turn points but you're sending
- the route to a GPS receiver that supports only 30 turnpoints, something has
- to go. One might use our 'simplify' filter to produce a route that
- retained the 30 most mathematically significant turnpoints but that
- may not really be the route you had in mind.
- </para>
- <para> Tracks and routes will sometimes be converted to a
+ <para>Many of those hazards can be overcome with our filters
+ but there are often compromises to be made. For example, if you
+ have a GPX route that contains 150 turn points but you're sending
+ the route to a GPS receiver that supports only 30 turnpoints, something has
+ to go. One might use our 'simplify' filter to produce a route that
+ retained the 30 most mathematically significant turnpoints but that
+ may not really be the route you had in mind.
+ </para>
+ <para>Tracks and routes will sometimes be converted to a
list of waypoints when necessary, One example is when writing into one
of the CSV formats. The inverse operation is not supported
right now, so reading the converted track back from CSV will
always result in a list of waypoints, not the original track.
</para>
- <para> The presence of <parameter moreinfo="none">-s</parameter> on the command line tends to
+ <para>The presence of
+ <parameter moreinfo="none">-s</parameter>
+ on the command line tends to
create havoc on tracks and routes since many of these formats
rely on internal linkages between such points and renaming
them may break those linkages. In general, don't use
- <parameter moreinfo="none">-s</parameter> when tracks or
- routes are present.
-</para>
-</sect1>
-<sect1 id="inifile">
- <title>Working with predefined options</title>
- <para>
- GPSBabel can read a file on startup to set defaults for options. All
- module and filter options may be set this way.
- </para>
- <para>
- The format of the file is identical to the inifile-format often seen
- on Windows. Here is an example:
+ <parameter moreinfo="none">-s</parameter>
+ when tracks or
+ routes are present.</para>
+ </sect1>
+ <sect1 id="inifile">
+ <title>Working with predefined options</title>
+ <para>GPSBabel can read a file on startup to set defaults for options. All
+ module and filter options may be set this way.
+ </para>
+ <para>The format of the file is identical to the inifile-format often seen
+ on Windows. Here is an example:
</para>
-<!--I don't know what the best "DOCbook-ese" is for this, but it's probably
+ <!--I don't know what the best "DOCbook-ese" is for this, but it's probably
not a simplelist... rjl -->
<simplelist columns="1">
<member>[Common format settings]</member>
<member>1=fixed waypoints</member>
<member>2=temporary waypoints</member>
</simplelist>
- <para>
- Each section of the file starts with a '[section]' header followed by any
+ <para>Each section of the file starts with a '[section]' header followed by any
number of lines formatted option=value. Leading and trailing whitespace
- will be
- automatically removed from header, option and value items.
-<!--Are there any other lines? If not, why name them? rjl -->
- Lines starting
- with '#' or ';' will be treated as comments and ignored.
- </para>
+ will be
+ automatically removed from header, option and value items.
- <para>
- There are three optional sections.
- <itemizedlist>
- <listitem>
- <para>Common format settings.</para>
- <para> Any option from any of the formats listed here will be used by
- GPSBabel unless explicitly provided on the command line.
- </para>
- </listitem>
- <listitem>
- <para>Common filter settings.</para>
- <para>As above, but for filters.</para>
- </listitem>
- <listitem>
- <para>Garmin categories</para>
- <para>This allows you to give readable names to the numeric categories
- used internally in some Garmin devices and the Mapsource formats
- such as GDB and MPS. This is information is also used by our GPX
- and garmin_txt formats as well.</para>
- </listitem>
+ <!--Are there any other lines? If not, why name them? rjl -->
+ Lines starting
+ with '#' or ';' will be treated as comments and ignored.</para>
+ <para>There are three optional sections.
+
+ <itemizedlist>
+ <listitem>
+ <para>Common format settings.</para>
+ <para>Any option from any of the formats listed here will be used by
+ GPSBabel unless explicitly provided on the command line.</para>
+ </listitem>
+ <listitem>
+ <para>Common filter settings.</para>
+ <para>As above, but for filters.</para>
+ </listitem>
+ <listitem>
+ <para>Garmin categories</para>
+ <para>This allows you to give readable names to the numeric categories
+ used internally in some Garmin devices and the Mapsource formats
+ such as GDB and MPS. This is information is also used by our GPX
+ and garmin_txt formats as well.</para>
+ </listitem>
</itemizedlist>
</para>
+ <para>By default, GPSBabel tries at startup to load the file named
- <para>
- By default, GPSBabel tries at startup to load the file named
- <filename>gpsbabel.ini</filename> from the following locations:
- </para>
+ <filename>gpsbabel.ini</filename>
+ from the following locations:</para>
<itemizedlist>
- <listitem><para>current working directory</para></listitem>
- <listitem><para>Windows: all paths "APPDATA", "WINDIR", "SYSTEMROOT" declared in environment.</para></listitem>
- <listitem><para>Unix like OS'ses: <filename>${HOME}/.gpsbabel/</filename>, <filename>/usr/local/etc/</filename> and <filename>/etc/</filename></para></listitem>
+ <listitem>
+ <para>current working directory</para>
+ </listitem>
+ <listitem>
+ <para>Windows: all paths "APPDATA", "WINDIR", "SYSTEMROOT" declared in environment.</para>
+ </listitem>
+ <listitem>
+ <para>Unix like OS'ses:
+ <filename>${HOME}/.gpsbabel/</filename>
+ ,
+ <filename>/usr/local/etc/</filename>
+ and
+ <filename>/etc/</filename></para>
+ </listitem>
</itemizedlist>
- <para>
- If the <option>-p</option> option is specified, the above locations are not searched.
- Only the filename specified by that option will be used.
- </para>
- <para>
- There may be situations where predefined values are not usable
- (i.e. wrapper applications using GPSBabel in the background).
+ <para>If the
+ <option>-p</option>
+ option is specified, the above locations are not searched.
+ Only the filename specified by that option will be used.</para>
+ <para>There may be situations where predefined values are not usable
+ (i.e. wrapper applications using GPSBabel in the background).
The inifile mechanism can be disabled with an empty filename.
</para>
- <para><userinput>gpsbabel -p "" -i gpx -f something.gpx -o tiger -F -</userinput></para>
-</sect1>
-<sect1 id="tracking">
- <title>Realtime tracking</title>
- <para>
- Introduced in GPSBabel 1.3.1, we now have an <emphasis>experimental</emphasis> feature for realtime tracking via the new <option>-T</option> option. This reads position reports from selected formats and writes an output file when a position report is received.
- </para>
<para>
- As of this writing, <link linkend="fmt_garmin">Garmin's PVT
- protocol</link> and
- <link linkend="fmt_nmea">NMEA</link> are supported
- inputs. KML, NMEA, and the various XCSV formats are supported on
- output. Additional formats may be added by interested parties
- later.
+ <userinput>gpsbabel -p "" -i gpx -f something.gpx -o tiger -F -</userinput>
</para>
-<example id="realtime_reading">
- <title>Read realtime positioning from Garmin USB, write to Keyhole Markup</title>
- <para><userinput>gpsbabel -T -i garmin -f usb: -o kml -F xxx.kml</userinput></para>
- <para>
- Will read the USB-connected Garmin and rewrite 'xxx.kml' atomically,
+ </sect1>
+ <sect1 id="tracking">
+ <title>Realtime tracking</title>
+ <para>Introduced in GPSBabel 1.3.1, we now have an
+ <emphasis>experimental</emphasis>
+ feature for realtime tracking via the new
+ <option>-T</option>
+ option. This reads position reports from selected formats and writes an output file when a position report is received. </para>
+ <para>As of this writing,
+ <link linkend="fmt_garmin">Garmin's PVT
+ protocol</link>
+ and
+
+ <link linkend="fmt_nmea">NMEA</link>
+ are supported
+ inputs. KML, NMEA, and the various XCSV formats are supported on
+ output. Additional formats may be added by interested parties
+ later.</para>
+ <example id="realtime_reading">
+ <title>Read realtime positioning from Garmin USB, write to Keyhole Markup</title>
+ <para>
+ <userinput>gpsbabel -T -i garmin -f usb: -o kml -F xxx.kml</userinput>
+ </para>
+ <para>Will read the USB-connected Garmin and rewrite 'xxx.kml' atomically,
suitable for a self-refreshing network link in Google Earth.
</para>
- </example>
-
-<example id="realtime_reading_wintec">
- <title>Read realtime positioning from Wintec WBT-201 via Bluetooth on Mac, write to Keyhole Markup</title>
- <para><userinput>gpsbabel -T -i nmea -f /dev/cu.G-Rays2-SPPslave-1 -o kml -F xxx.kml</userinput></para>
- <para>
- Will read the Wintec WBT-201 via Bluetooth, using the name that
+ </example>
+ <example id="realtime_reading_wintec">
+ <title>Read realtime positioning from Wintec WBT-201 via Bluetooth on Mac, write to Keyhole Markup</title>
+ <para>
+ <userinput>gpsbabel -T -i nmea -f /dev/cu.G-Rays2-SPPslave-1 -o kml -F xxx.kml</userinput>
+ </para>
+ <para>Will read the Wintec WBT-201 via Bluetooth, using the name that
the Mac assigned it, and rewrite 'xxx.kml' atomically,
suitable for a self-refreshing network link in Google Earth.
</para>
-</example>
-
+ </example>
+ <para>Be sure to substitute an device name appropriate for your device
+ and OS, such as
+ <filename>/dev/cu.usbserial</filename>
+ or
- <para>
- Be sure to substitute an device name appropriate for your device
- and OS, such as <filename>/dev/cu.usbserial</filename> or
- <filename>/dev/cu.BT-GPS-37A695-BT-GPSCOM-1</filename>
- for Mac, <filename>COM23:</filename> for Windows, or
- <filename>usb:</filename> for
- <link linkend="fmt_garmin">Garmin USB</link>. These names
- (except the "usb:" parlance for Garmin USB) are assigned by
- your operating system.
+ <filename>/dev/cu.BT-GPS-37A695-BT-GPSCOM-1</filename>
+ for Mac,
+ <filename>COM23:</filename>
+ for Windows, or
- </para>
-</sect1>
+ <filename>usb:</filename>
+ for
-<sect1 id="batchfile">
- <title>Batch mode (command files)</title>
- <para>
- In addition to reading arguments from the command line, GPSBabel can
- read directions from batch (or command) files via the <option>-b</option> option.
- </para>
- <para>
- These files are ideal for holding long command lines, long file lists, complex filters
+ <link linkend="fmt_garmin">Garmin USB</link>
+ . These names
+ (except the "usb:" parlance for Garmin USB) are assigned by
+ your operating system.</para>
+ </sect1>
+ <sect1 id="batchfile">
+ <title>Batch mode (command files)</title>
+ <para>In addition to reading arguments from the command line, GPSBabel can
+ read directions from batch (or command) files via the
+ <option>-b</option>
+ option.</para>
+ <para>These files are ideal for holding long command lines, long file lists, complex filters
and so on. You can use all GPSBabel options and combinations when writing
- such files. Nesting batch files by using the <option>-b</option> option within a batch file is supported.
- </para>
- <para>
- Here is an example demonstrating segmenting a large command line
+ such files. Nesting batch files by using the
+ <option>-b</option>
+ option within a batch file is supported.</para>
+ <para>Here is an example demonstrating segmenting a large command line
by placing the input and filtering directives in a file called 'all_my_files'.
</para>
- <para><userinput>gpsbabel -b all_my_files -o gdb -F all_my_tracks.gdb</userinput></para>
- <para>
- 'all_my_files' could look like this:
- </para>
- <simplelist columns="1">
- <member>-i gpx</member>
- <member>-f saxony_in_summer_2004.gpx -f austria_2005.gpx</member>
- <member>-i gdb</member>
- <member>-f croatia_2006.gdb</member>
- <member>-x nuketypes,waypoints,routes</member>
- <member>-x track,pack,split,title="LOG # %Y%m%d"</member>
- </simplelist>
-</sect1>
- <sect1 id="all_options">
- <title>List of Options</title>
- <para>
- The complete list of available options to GPSBabel can be obtained by
- running <command>gpsbabel -h</command>. While there are a number of
- options, most people will not use most of them, so don't be intimidated.
+ <para>
+ <userinput>gpsbabel -b all_my_files -o gdb -F all_my_tracks.gdb</userinput>
+ </para>
+ <para>'all_my_files' could look like this:
</para>
-<para><option>-p</option> Read preferences file. On startup, GPSBabel will look for a file named <filename>gpsbabel.ini</filename> containing preferences you have provided. This option lets you pick a different files. See <xref linkend="inifile"/> for more info.</para>
-<para><option>-s</option> Write "smart" names. This option influences some - but not all - of our writers to try to build "smart" waypoint names. For example, in modules that know about geocaching, it may replace "GC1234" with the actual name of the geocache.</para>
-<para><option>-r</option> Work on routes. This option has a subtly different meaning in different cases. As the very first formats in GPSBabel were for serial GPSes and routes and tracks were large and thus time-consuming to transfer, the default was waypoints only with this option to turn on the extra data. Some of our file formats use this option to mean "work only on routes, even if you have tracks/waypoints", but we're trying to discourage that behavior and in most cases, consider it a bug. </para>
-<para><option>-t</option> Work on tracks. See <option>-r</option> for excuses. </para>
-<para><option>-w</option> Work on waypoints. This is the default. </para>
-<para><option>-T</option> Enable Realtime tracking. This option isn't supported by the majority of our file formats, but repeatedly reads location from a GPS and writes it to a file as described in <xref linkend="tracking" /></para>
-<para><option>-b</option> Process batch file. In addition to reading arguments from the command line, we can read them from files containing lists of commands as described in <xref linkend="batchfile"/> </para>
-<para><option>-x filter</option> Run filter. This option lets use use one of of our many data filters. Position of this in the command line does matter - remember, we process left to right.</para>
-<para><option>-D</option> Enable debugging. Not all formats support this. It's typically better supported by the various protocol modules because they just plain need more debugging. This option may be followed by a number. Zero means no debugging. Larger numbers mean more debugging. </para>
-<para><option>-h</option><option>-?</option> Print help. </para>
-<para><option>-V</option> Print version number. </para>
- </sect1>
-</chapter>
+ <simplelist columns="1">
+ <member>-i gpx</member>
+ <member>-f saxony_in_summer_2004.gpx -f austria_2005.gpx</member>
+ <member>-i gdb</member>
+ <member>-f croatia_2006.gdb</member>
+ <member>-x nuketypes,waypoints,routes</member>
+ <member>-x track,pack,split,title="LOG # %Y%m%d"</member>
+ </simplelist>
+ </sect1>
+ <sect1 id="all_options">
+ <title>List of Options</title>
+ <para>The complete list of available options to GPSBabel can be obtained by
+ running
+ <command>gpsbabel -h</command>
+ . While there are a number of
+ options, most people will not use most of them, so don't be intimidated.</para>
+ <para>
+ <option>-p</option>Read preferences file. On startup, GPSBabel will look for a file named
+ <filename>gpsbabel.ini</filename>
+ containing preferences you have provided. This option lets you pick a different files. See
+ <xref linkend="inifile"/>
+ for more info.</para>
+ <para>
+ <option>-s</option>Write "smart" names. This option influences some - but not all - of our writers to try to build "smart" waypoint names. For example, in modules that know about geocaching, it may replace "GC1234" with the actual name of the geocache.</para>
+ <para>
+ <option>-r</option>Work on routes. This option has a subtly different meaning in different cases. As the very first formats in GPSBabel were for serial GPSes and routes and tracks were large and thus time-consuming to transfer, the default was waypoints only with this option to turn on the extra data. Some of our file formats use this option to mean "work only on routes, even if you have tracks/waypoints", but we're trying to discourage that behavior and in most cases, consider it a bug. </para>
+ <para>
+ <option>-t</option>Work on tracks. See
+ <option>-r</option>
+ for excuses. </para>
+ <para>
+ <option>-w</option>Work on waypoints. This is the default. </para>
+ <para>
+ <option>-T</option>Enable Realtime tracking. This option isn't supported by the majority of our file formats, but repeatedly reads location from a GPS and writes it to a file as described in
+ <xref linkend="tracking"/></para>
+ <para>
+ <option>-b</option>Process batch file. In addition to reading arguments from the command line, we can read them from files containing lists of commands as described in
+ <xref linkend="batchfile"/></para>
+ <para>
+ <option>-x filter</option>Run filter. This option lets use use one of of our many data filters. Position of this in the command line does matter - remember, we process left to right.</para>
+ <para>
+ <option>-D</option>Enable debugging. Not all formats support this. It's typically better supported by the various protocol modules because they just plain need more debugging. This option may be followed by a number. Zero means no debugging. Larger numbers mean more debugging. </para>
+ <para>
+ <option>-h</option>
+ <option>-?</option>Print help. </para>
+ <para>
+ <option>-V</option>Print version number. </para>
+ </sect1>
+</chapter>
\ No newline at end of file
projects / gpsbabel.git / commitdiff